source: trunk/examples/objects/api/cpp/number @ 1586

Number

constructors/destructors
    Number()
    Number(const char *name, const char *units, double val);
    Number(const char *name, const char *units, double val,
           double min, double max, const char *label,
           const char *desc);
    Number(const Number& o);
    ~Number ();

methods
    const char *name() const;
    void name(const char *val);

    const char *path() const;
    void path(const char *val);

    const char *label() const;
    void label(const char *val);

    const char *desc() const;
    void desc(const char *val);

    const char *hints() const;
    void hints(const char *val);

    const char *color() const;
    void color(const char *val);

    double def() const;
    void def(double val);

    double cur() const;
    void cur(double val);

    double min() const;
    void min(double val);

    double max() const;
    void max(double val);

    const char *units() const;
    void units(const char *u);

    int defset() const;
    int curset() const;

    const void *property (const char *key) const;
    void property (const char *key, const void *val, size_t nbytes);

    const char *propstr (const char *key) const;
    void propstr (const char *key, const char *val);

    void propremove (const char *key);

    Outcome& convert(const char *to);
    double value(const char *units) const;
    void vvalue(void *storage, size_t numHints, va_list arg) const;
    void random();
    Rp_Chain *diff(const Object& o);

    Number& addPreset(const char *label, const char *desc,
                      double val, const char *units);

    Number& addPreset(const char *label, const char *desc,
                      const char *val);

    Number& delPreset(const char *label);

    void configure(size_t as, ClientData c);
    void dump(size_t as, ClientData c);

    Outcome &outcome() const;

    const int is() const;

    void minFromStr(const char *val);
    void maxFromStr(const char *val);
    void defFromStr(const char *val);
    void curFromStr(const char *val);

---------------------------------------

const char *name()
    Purpose: get the id name of the object
    Input Arguments: None
    Return Value: the id name stored in the object.
    Notes: if no name is set, NULL will be returned
            the id name is used to identify this object from
            all other objects and should be unique
    Code Example:

void name(const char *val)
    Purpose: set the id name of the object
    Input Arguments: 1
        1. const char *val - new id name
    Return Value: None
    Notes: a copy of the memory location val will be stored
    Code Example:

const char *path()
    Purpose: get the path of the object
    Input Arguments: None
    Return Value: the path stored in the object.
    Notes: if no path is set, NULL will be returned
            the path tells where this object sits in the
            hierarchy of objects.
    Code Example:

void path(const char *val)
    Purpose: set the path of the object
    Input Arguments: 1
        1. const char *val - new path
    Return Value: None
    Notes: a copy of the memory location val will be stored
    Code Example:

const char *label()
    Purpose: get the label of the object
    Input Arguments: None
    Return Value: the label stored in the object.
    Notes: if no label is set, NULL will be returned
            the label is used by the graphical user interface.
    Code Example:

void label(const char *val)
    Purpose: set the label of the object
    Input Arguments: 1
        1. const char *val - new label
    Return Value: None
    Notes: a copy of the memory location val will be stored
    Code Example:

const char *desc()
    Purpose: get the description of the object
    Input Arguments: None
    Return Value: the description stored in the object.
    Notes: if no description is set, NULL will be returned
            the description is used by the graphical user
            interface to describe what type of data is being
            requested and how the input is used.
    Code Example:

void desc(const char *val)
    Purpose: set the description of the object
    Input Arguments: 1
        1. const char *val - new description
    Return Value: None
    Notes: a copy of the memory location val will be stored
    Code Example:

const char *hints()
    Purpose: get the hints of the object
    Input Arguments: None
    Return Value: the hints stored in the object.
    Notes: if no hints are set, NULL will be returned
            the hints are used by the graphical user interface
    Code Example:

void hints(const char *val)
    Purpose: set the hints of the object
    Input Arguments: 1
        1. const char *val - new hints
    Return Value: None
    Notes: a copy of the memory location val will be stored
    Code Example:

double def()
    Purpose: get the default value
    Input Arguments: None
    Return Value: the default value stored in the object.
    Notes: use the function defset() to see if a valid
            default value was stored in the object.
    Code Example:

void def(double val)
    Purpose: set the default value
    Input Arguments: 1
        1. double val - new default value
    Return Value: None
    Notes: None
    Code Example:

double cur()
    Purpose: get the current value
    Input Arguments: None
    Return Value: the current value stored in the object.
    Notes: use the function curset() to see if a valid
            default value was stored in the object.
    Code Example:

void cur(double val)
    Purpose: set the current value
    Input Arguments: 1
        1. double val - new current value
    Return Value: None
    Notes: None
    Code Example:

double min()
    Purpose: get the minimum accepted value of this object
    Input Arguments: None
    Return Value: the minimum value this object will accept.
    Notes: use the function minset() to see if a valid
            minimum value was stored in the object.
    Code Example:

void min(double val)
    Purpose: set the minimum accepted value of this object
    Input Arguments: 1
        1. double val - new minimum accepted value
    Return Value: None
    Notes: None
    Code Example:

double max()
    Purpose: get the maximum accepted value of this object
    Input Arguments: None
    Return Value: the maximum value this object will accept.
    Notes: use the function maxset() to see if a valid
            maximum value was stored in the object.
    Code Example:

void max(double val)
    Purpose: set the maximum accepted value of this object
    Input Arguments: 1
        1. double val - new maximum accepted value
    Return Value: None
    Notes: None
    Code Example:

const char* units()
    Purpose: get the units of this object
    Input Arguments: None
    Return Value: the string representing the object's units
    Notes: None
    Code Example:

void units(const char *val)
    Purpose: set the units of this object
    Input Arguments: 1
        1. const char *val - new units
    Return Value: None
    Notes: None
    Code Example:

int defset() const
    Purpose: return whether the default value was set by the user
    Input Arguments: None
    Return Value: 1 if default was set by user, otherwise 0
    Notes: None
    Code Example:

int curset() const
    Purpose: return whether the current value was set by the user
    Input Arguments: None
    Return Value: 1 if current was set by user, otherwise 0
    Notes: None
    Code Example:

const void *property (const char *key) const;
    Purpose: get a generic property from the property database
    Input Arguments: 1
        1. const char *key - property name
    Return Value: value of the property
    Notes: None
    Code Example:

void property (const char *key, const void *val, size_t nbytes);
    Purpose: set a generic property in the property database
    Input Arguments: 3
        1. const char *key - property name
        2. const void *val - property value
        3. size_t nbytes - size (in bytes) of the value
    Return Value: None
    Notes: A copy of the memory pointed to by val is stored
            in the property database
    Code Example:

const char *propstr (const char *key) const;
    Purpose: get a string property from the property database
    Input Arguments: 1
        1. const char *key - property name
    Return Value: value of the property
    Notes: None
    Code Example:

void propstr (const char *key, const char *val);
    Purpose: set a string property in the property database
    Input Arguments: 2
        1. const char *key - property name
        2. const char *val - property value
    Return Value: None
    Notes: A copy of the memory pointed to by val is stored
            in the property database
    Code Example:

void propremove (const char *key);
    Purpose: remove a property from the property database
    Input Arguments: 1
        1. const char *key - property name
    Return Value: value of the property
    Notes: None
    Code Example:

Outcome& convert(const char *to);
    Purpose: convert the def and cur values to "to" units
    Input Arguments: 1
        1. const char *to - string of units to convert to
    Return Value: Outcome object
    Notes: the values stored in the object are changed
    Code Example:

double value(const char *to) const;
    Purpose: return the value of the object with units of "to"
    Input Arguments: 1
        1. const char *to - string of units to convert to
    Return Value: value of the object
    Notes: cur() is used as the base value. if cur was not set
            by the user (curset() == 0), def() is used.
            if def was not set (defset() == 0), 0.0 is used
            as the value.
    Code Example:

void vvalue(void *storage, size_t numHints, va_list arg) const;
    Purpose: return the value of the object after applying a
                varying number of hints about how the value
                should be configured
    Input Arguments: 3
        1. void *storage - the return value
        2. size_t numHints - number of hints provided
        3. va_list arg - list of hints specified as a va_list
    Return Value: None
    Notes: vvalue will parse out the recognisable hints from
                va_list arg. Values stored in the object are
                not changed.
    Code Example:

void random();
    Purpose: populate the object with a random value
    Input Arguments: 0
    Return Value: None
    Notes: the current value of this object will be populated
           with a random value that fits within the min and
           max if they were specified.
    Code Example:

Rp_Chain *diff(const Rp_Object &o);
    Purpose: return a linked list showing the differences between
             this object and Rp_Object &o
    Input Arguments: 1
        1. const Rp_Object &o - object to diff against
    Return Value: list of differences between objects
    Notes: None
    Code Example:

Number& addPreset(const char *label, const char *desc,
                  double val, const char *units);
    Purpose: add a preset to this object
    Input Arguments: 4
        1. const char *label - label of the preset
        2. const char *desc - description of the preset
        3. double val - value of the preset
        4. const char *units - units of the preset
    Return Value: None
    Notes: presets are stored in the object in the same order
                in which they are created
    Code Example:

Number& addPreset(const char *label, const char *desc,
                  const char *val);
    Purpose: add a preset to this object
    Input Arguments: 3
        1. const char *label - label of the preset
        2. const char *desc - description of the preset
        3. const char *val - numeric value and units of the preset
    Return Value: None
    Notes: presets are stored in the object in the same order
                in which they are created
    Code Example:

Number& delPreset(const char *label);
    Purpose: delete the preset labeled "label" from this object
    Input Arguments: 1
        1. const char *label - label of the preset
    Return Value: None
    Notes: preset is removed from the object
    Code Example:

void configure(size_t as, ClientData c);
    Purpose: configure the object based on the data in "c".
                use "as" to determine the type of data in "c".
    Input Arguments: 2
        1. size_t as - type of data stored in "c".
                        valid values include:
                            RPCONFIG_XML
                            RPCONFIG_TREE
        2. ClientData c - data to configure the object from.
                            if as is...     then c should be...
                            RPCONFIG_XML    const char *xmltext
                            RPCONFIG_TREE   RP_ParserXML *object
    Return Value: None
    Notes: object is configured based on values in "c"
    Code Example:

void dump(size_t as, ClientData c);
    Purpose: dump the object values based to the object "c".
                use "as" to determine how to dump the data.
    Input Arguments: 2
        1. size_t as - type of data stored in "c".
                        valid values include:
                            RPCONFIG_XML
                            RPCONFIG_TREE
        2. ClientData c - data to configure the object from.
                            if as is...     then c should be...
                            RPCONFIG_XML    ClientDataXml *object
                            RPCONFIG_TREE   RP_ParserXML *object
    Return Value: None
    Notes: None
    Code Example:

Outcome &outcome() const;
    Purpose: return the status of this object as an Outcome.
    Input Arguments: 0
    Return Value: status of the object as an Outcome
    Notes: None
    Code Example:

const int is() const;
    Purpose: return an integer tag describing the object.
    Input Arguments: 0
    Return Value: integer tag unique to all number objects
    Notes: None
    Code Example:

void minFromStr(const char *val);
    Purpose: populate the min() value from a string.
    Input Arguments: 1
        1. const char *val - value and units for the
                                minimum value
    Return Value: None
    Notes: This function tries to parse the string for a value
            and a units string. if a units string is found and
            no units have been set for the object, these units
            become the units for the object. if there are
            already units for this object, any value found
            during the split is converted to the object's
            units before being stored in min().
    Code Example:

void maxFromStr(const char *val);
    Purpose: populate the max() value from a string.
    Input Arguments: 1
        1. const char *val - value and units for the
                                maximum value
    Return Value: None
    Notes: This function tries to parse the string for a value
            and a units string. if a units string is found and
            no units have been set for the object, these units
            become the units for the object. if there are
            already units for this object, any value found
            during the split is converted to the object's
            units before being stored in max().
    Code Example:

void defFromStr(const char *val);
    Purpose: populate the def() value from a string.
    Input Arguments: 1
        1. const char *val - value and units for the
                                default value
    Return Value: None
    Notes: This function tries to parse the string for a value
            and a units string. if a units string is found and
            no units have been set for the object, these units
            become the units for the object. if there are
            already units for this object, any value found
            during the split is converted to the object's
            units before being stored in def().
    Code Example:

void curFromStr(const char *val);
    Purpose: populate the cur() value from a string.
    Input Arguments: 1
        1. const char *val - value and units for the
                                current value
    Return Value: None
    Notes: This function tries to parse the string for a value
            and a units string. if a units string is found and
            no units have been set for the object, these units
            become the units for the object. if there are
            already units for this object, any value found
            during the split is converted to the object's
            units before being stored in cur().
    Code Example: