The XML attributes interface. More...
#include "murl_i_attributes.h"
Public Member Functions | |
virtual | ~IAttributes ()=default |
The destructor. | |
virtual Bool | Clear ()=0 |
Clear all attributes. More... | |
virtual Bool | AddDefaults (const IAttributes *defaultAttributes)=0 |
Add a set of default attributes for named queries. More... | |
virtual UInt32 | GetNumberOfDefaults () const =0 |
Get the number of default attribute sets added via AddDefaults(). More... | |
virtual const IAttributes * | GetDefaults (UInt32 index) const =0 |
Get the default attribute set at a given index. More... | |
virtual Bool | AddAttribute (const String &fullName, const String &value)=0 |
Add a single attribute name and value. More... | |
virtual Bool | SetAttribute (const String &fullName, const String &value)=0 |
Set a value for a named attribute. More... | |
virtual UInt32 | GetNumberOfAttributes () const =0 |
Get the number of attributes. More... | |
virtual UInt32 | GetAttributeHash (UInt32 index, UInt32 level=0) const =0 |
Get the hash of an attribute name. More... | |
virtual const Char * | GetAttributeName (UInt32 index, UInt32 level=0) const =0 |
Get the name of an attribute. More... | |
virtual const Char * | GetAttributeValue (UInt32 index, UInt32 level=0) const =0 |
Get the value of an attribute. More... | |
virtual String | GetFullAttributeName (UInt32 index) const =0 |
Get the full name of an attribute. More... | |
virtual const Char * | GetFullAttributeValue (UInt32 index) const =0 |
Get the value of an attribute (ignoring the level). More... | |
virtual SInt32 | GetAttributeIndex (const char *name) const =0 |
Get the index of an attribute name at level 0. More... | |
virtual SInt32 | GetFullAttributeIndex (const char *fullName) const =0 |
Get the index of a fully qualified attribute. More... | |
virtual SInt32 | GetAttributeParent (UInt32 index) const =0 |
Get the parent index of an attribute. More... | |
virtual UInt32 | GetAttributeLevel (UInt32 index) const =0 |
Get the level of an attribute. More... | |
virtual Bool | IsAttributeUsed (UInt32 index) const =0 |
Check if the attribute is used. More... | |
virtual Bool | HasAttributeValue (UInt32 index) const =0 |
Check if the attribute has a value. More... | |
virtual UInt32 | GetNumberOfUnusedAttributes () const =0 |
Get the number of unused attributes. More... | |
virtual Bool | GetUnusedAttributeNames (StringArray &names) const =0 |
Get the names of unused attributes. More... | |
virtual Bool | SetAllAttributesUsed () const =0 |
Set all attributes to used state. More... | |
virtual Bool | EvaluateExpression (const Char *expression, String &value, Bool &error) const =0 |
Evaluate an expression string. More... | |
virtual Bool | EvaluateExpression (const Char *expression, String &value, Result &result) const =0 |
Evaluate an expression string. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, String &value, Bool &error) const =0 |
Get the string value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, Bool &value, Bool &error) const =0 |
Get the boolean value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, UInt32 &value, Bool &error) const =0 |
Get the unsigned integer value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, SInt32 &value, Bool &error) const =0 |
Get the signed integer value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, Double &value, Bool &error) const =0 |
Get the double value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, Float &value, Bool &error) const =0 |
Get the float value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, Color &value, Bool &error) const =0 |
Get the color value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, String &value, Result &result) const =0 |
Get the string value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, Bool &value, Result &result) const =0 |
Get the boolean value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, UInt32 &value, Result &result) const =0 |
Get the unsigned integer value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, SInt32 &value, Result &result) const =0 |
Get the signed integer value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, Double &value, Result &result) const =0 |
Get the double value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, Float &value, Result &result) const =0 |
Get the float value of an attribute by index. More... | |
virtual Bool | GetValueByIndex (UInt32 index, const IAttributes *params, Color &value, Result &result) const =0 |
Get the color value of an attribute by index. More... | |
virtual Bool | GetAngleValueByIndex (UInt32 index, const IAttributes *params, Double &value, Bool &error) const =0 |
Get the angle double value of an attribute by index. More... | |
virtual Bool | GetAngleValueByIndex (UInt32 index, const IAttributes *params, Float &value, Bool &error) const =0 |
Get the angle float value of an attribute by index. More... | |
virtual Bool | GetColorValueByIndex (UInt32 index, const IAttributes *params, Float &value, Bool &error) const =0 |
Get the color component value of an attribute by index. More... | |
virtual Bool | GetAngleValueByIndex (UInt32 index, const IAttributes *params, Double &value, Result &result) const =0 |
Get the angle double value of an attribute by index. More... | |
virtual Bool | GetAngleValueByIndex (UInt32 index, const IAttributes *params, Float &value, Result &result) const =0 |
Get the angle float value of an attribute by index. More... | |
virtual Bool | GetColorValueByIndex (UInt32 index, const IAttributes *params, Float &value, Result &result) const =0 |
Get the color component value of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, StringArray &values, Bool &error, Bool clear=true) const =0 |
Get the string values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, BoolArray &values, Bool &error, Bool clear=true) const =0 |
Get the boolean values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, UInt32Array &values, Bool &error, Bool clear=true) const =0 |
Get the unsigned integer values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, SInt32Array &values, Bool &error, Bool clear=true) const =0 |
Get the signed integer values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, DoubleArray &values, Bool &error, Bool clear=true) const =0 |
Get the double values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, FloatArray &values, Bool &error, Bool clear=true) const =0 |
Get the float values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, StringArray &values, Result &result, Bool clear=true) const =0 |
Get the string values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, BoolArray &values, Result &result, Bool clear=true) const =0 |
Get the boolean values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, UInt32Array &values, Result &result, Bool clear=true) const =0 |
Get the unsigned integer values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, SInt32Array &values, Result &result, Bool clear=true) const =0 |
Get the signed integer values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, DoubleArray &values, Result &result, Bool clear=true) const =0 |
Get the double values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, FloatArray &values, Result &result, Bool clear=true) const =0 |
Get the float values of an attribute by index. More... | |
virtual Bool | GetAngleValuesByIndex (UInt32 index, const IAttributes *params, DoubleArray &values, Bool &error, Bool clear=true) const =0 |
Get the double angle values of an attribute by index. More... | |
virtual Bool | GetAngleValuesByIndex (UInt32 index, const IAttributes *params, FloatArray &values, Bool &error, Bool clear=true) const =0 |
Get the float angle values of an attribute by index. More... | |
virtual Bool | GetAngleValuesByIndex (UInt32 index, const IAttributes *params, DoubleArray &values, Result &result, Bool clear=true) const =0 |
Get the double angle values of an attribute by index. More... | |
virtual Bool | GetAngleValuesByIndex (UInt32 index, const IAttributes *params, FloatArray &values, Result &result, Bool clear=true) const =0 |
Get the float angle values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, String *values, UInt32 maxValues, Bool &error, UInt32 *numValues=nullptr) const =0 |
Get the String values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, Bool *values, UInt32 maxValues, Bool &error, UInt32 *numValues=nullptr) const =0 |
Get the boolean values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, UInt32 *values, UInt32 maxValues, Bool &error, UInt32 *numValues=nullptr) const =0 |
Get the unsigned integer values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, SInt32 *values, UInt32 maxValues, Bool &error, UInt32 *numValues=nullptr) const =0 |
Get the signed integer values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, Double *values, UInt32 maxValues, Bool &error, UInt32 *numValues=nullptr) const =0 |
Get the double values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, Float *values, UInt32 maxValues, Bool &error, UInt32 *numValues=nullptr) const =0 |
Get the float values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, String *values, UInt32 maxValues, Result &result, UInt32 *numValues=nullptr) const =0 |
Get the String values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, Bool *values, UInt32 maxValues, Result &result, UInt32 *numValues=nullptr) const =0 |
Get the boolean values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, UInt32 *values, UInt32 maxValues, Result &result, UInt32 *numValues=nullptr) const =0 |
Get the unsigned integer values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, SInt32 *values, UInt32 maxValues, Result &result, UInt32 *numValues=nullptr) const =0 |
Get the signed integer values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, Double *values, UInt32 maxValues, Result &result, UInt32 *numValues=nullptr) const =0 |
Get the double values of an attribute by index. More... | |
virtual Bool | GetValuesByIndex (UInt32 index, const IAttributes *params, Float *values, UInt32 maxValues, Result &result, UInt32 *numValues=nullptr) const =0 |
Get the float values of an attribute by index. More... | |
virtual Bool | GetAngleValuesByIndex (UInt32 index, const IAttributes *params, Double *values, UInt32 maxValues, Bool &error, UInt32 *numValues=nullptr) const =0 |
Get the double angle values of an attribute by index. More... | |
virtual Bool | GetAngleValuesByIndex (UInt32 index, const IAttributes *params, Float *values, UInt32 maxValues, Bool &error, UInt32 *numValues=nullptr) const =0 |
Get the float angle values of an attribute by index. More... | |
virtual Bool | GetAngleValuesByIndex (UInt32 index, const IAttributes *params, Double *values, UInt32 maxValues, Result &result, UInt32 *numValues=nullptr) const =0 |
Get the double angle values of an attribute by index. More... | |
virtual Bool | GetAngleValuesByIndex (UInt32 index, const IAttributes *params, Float *values, UInt32 maxValues, Result &result, UInt32 *numValues=nullptr) const =0 |
Get the float angle values of an attribute by index. More... | |
virtual Bool | GetBitsToSetByIndex (UInt32 index, const IAttributes *params, UInt32 &value, Bool &error) const =0 |
Get the bit number values of an attribute by index and set the bits. More... | |
virtual Bool | GetBitsToSetByIndex (UInt32 index, const IAttributes *params, UInt32 &value, Result &result) const =0 |
Get the bit number values of an attribute by index and set the bits. More... | |
template<class EnumType > | |
Bool | GetEnumValueByIndex (UInt32 index, const IAttributes *params, const Enum< EnumType > &enumClass, EnumType &value, Bool &error) const |
Get the enumeration value of an attribute by index. More... | |
template<class EnumType > | |
Bool | GetEnumValueByIndex (UInt32 index, const IAttributes *params, const Enum< EnumType > &enumClass, EnumType &value, Result &result) const |
Get the enumeration value of an attribute by index. More... | |
template<class EnumType > | |
Bool | GetEnumValuesByIndex (UInt32 index, const IAttributes *params, const Enum< EnumType > &enumClass, Array< EnumType > &values, Bool &error, Bool clear=true) const |
Get the enumeration values of an attribute by index. More... | |
template<class EnumType > | |
Bool | GetEnumValuesByIndex (UInt32 index, const IAttributes *params, const Enum< EnumType > &enumClass, EnumType *values, UInt32 maxValues, Bool &error, UInt32 *numValues=nullptr) const |
Get the enumeration values of an attribute by index. More... | |
template<class EnumType > | |
Bool | GetEnumValuesByIndex (UInt32 index, const IAttributes *params, const Enum< EnumType > &enumClass, Array< EnumType > &values, Result &result, Bool clear=true) const |
Get the enumeration values of an attribute by index. More... | |
template<class EnumType > | |
Bool | GetEnumValuesByIndex (UInt32 index, const IAttributes *params, const Enum< EnumType > &enumClass, EnumType *values, UInt32 maxValues, Result &result, UInt32 *numValues=nullptr) const |
Get the enumeration values of an attribute by index. More... | |
template<class EnumType > | |
Bool | GetEnumBitsToSetByIndex (UInt32 index, const IAttributes *params, const Enum< EnumType > &enumClass, UInt32 &value, Bool &error) const |
Get the enumerated bit number values of an attribute by index and set the bits. More... | |
template<class EnumType > | |
Bool | GetEnumBitsToSetByIndex (UInt32 index, const IAttributes *params, const Enum< EnumType > &enumClass, UInt32 &value, Result &result) const |
Get the enumerated bit number values of an attribute by index and set the bits. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, String &value, Bool &error) const =0 |
Get the string value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, Bool &value, Bool &error) const =0 |
Get the boolean value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, UInt32 &value, Bool &error) const =0 |
Get the unsigned integer value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, SInt32 &value, Bool &error) const =0 |
Get the signed integer value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, Double &value, Bool &error) const =0 |
Get the double value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, Float &value, Bool &error) const =0 |
Get the float value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, Color &value, Bool &error) const =0 |
Get the color value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, String &value, Result &result) const =0 |
Get the string value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, Bool &value, Result &result) const =0 |
Get the boolean value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, UInt32 &value, Result &result) const =0 |
Get the unsigned integer value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, SInt32 &value, Result &result) const =0 |
Get the signed integer value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, Double &value, Result &result) const =0 |
Get the double value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, Float &value, Result &result) const =0 |
Get the float value of an attribute by name at level 0. More... | |
virtual Bool | GetValueByName (const Char *name, const IAttributes *params, Color &value, Result &result) const =0 |
Get the color value of an attribute by name at level 0. More... | |
virtual Bool | GetAngleValueByName (const Char *name, const IAttributes *params, Double &value, Bool &error) const =0 |
Get the angle double value of an attribute by name at level 0. More... | |
virtual Bool | GetAngleValueByName (const Char *name, const IAttributes *params, Float &value, Bool &error) const =0 |
Get the angle float value of an attribute by name at level 0. More... | |
virtual Bool | GetColorValueByName (const Char *name, const IAttributes *params, Float &value, Bool &error) const =0 |
Get the color component value of an attribute by name at level 0. More... | |
virtual Bool | GetAngleValueByName (const Char *name, const IAttributes *params, Double &value, Result &result) const =0 |
Get the angle double value of an attribute by name at level 0. More... | |
virtual Bool | GetAngleValueByName (const Char *name, const IAttributes *params, Float &value, Result &result) const =0 |
Get the angle float value of an attribute by name at level 0. More... | |
virtual Bool | GetColorValueByName (const Char *name, const IAttributes *params, Float &value, Result &result) const =0 |
Get the color component value of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, StringArray &values, Bool &error, Bool clear=true) const =0 |
Get the string values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, BoolArray &values, Bool &error, Bool clear=true) const =0 |
Get the boolean values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, UInt32Array &values, Bool &error, Bool clear=true) const =0 |
Get the unsigned integer values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, SInt32Array &values, Bool &error, Bool clear=true) const =0 |
Get the signed integer values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, DoubleArray &values, Bool &error, Bool clear=true) const =0 |
Get the double values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, FloatArray &values, Bool &error, Bool clear=true) const =0 |
Get the float values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, StringArray &values, Result &result, Bool clear=true) const =0 |
Get the string values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, BoolArray &values, Result &result, Bool clear=true) const =0 |
Get the boolean values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, UInt32Array &values, Result &result, Bool clear=true) const =0 |
Get the unsigned integer values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, SInt32Array &values, Result &result, Bool clear=true) const =0 |
Get the signed integer values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, DoubleArray &values, Result &result, Bool clear=true) const =0 |
Get the double values of an attribute by name at level 0. More... | |
virtual Bool | GetValuesByName (const Char *name, const IAttributes *params, FloatArray &values, Result &result, Bool clear=true) const =0 |
Get the float values of an attribute by name at level 0. More... | |
virtual Bool | GetAngleValuesByName (const Char *name, const IAttributes *params, DoubleArray &values, Bool &error, Bool clear=true) const =0 |
Get the double angle values of an attribute by name at level 0. More... | |
virtual Bool | GetAngleValuesByName (const Char *name, const IAttributes *params, FloatArray &values, Bool &error, Bool clear=true) const =0 |
Get the float angle values of an attribute by name at level 0. More... | |
virtual Bool | GetAngleValuesByName (const Char *name, const IAttributes *params, DoubleArray &values, Result &result, Bool clear=true) const =0 |
Get the double angle values of an attribute by name at level 0. More... | |
virtual Bool | GetAngleValuesByName (const Char *name, const IAttributes *params, FloatArray &values, Result &result, Bool clear=true) const =0 |
Get the float angle values of an attribute by name at level 0. More... | |
virtual Bool | GetBitsToSetByName (const Char *name, const IAttributes *params, UInt32 &value, Bool &error) const =0 |
Get the bit number values of an attribute by name at level 0 and set the bits. More... | |
virtual Bool | GetBitsToSetByName (const Char *name, const IAttributes *params, UInt32 &value, Result &result) const =0 |
Get the bit number values of an attribute by name at level 0 and set the bits. More... | |
template<class EnumType > | |
Bool | GetEnumValueByName (const Char *name, const IAttributes *params, const Enum< EnumType > &enumClass, EnumType &value, Bool &error) const |
Get the enumeration value of an attribute by name at level 0. More... | |
template<class EnumType > | |
Bool | GetEnumValueByName (const Char *name, const IAttributes *params, const Enum< EnumType > &enumClass, EnumType &value, Result &result) const |
Get the enumeration value of an attribute by name at level 0. More... | |
template<class EnumType > | |
Bool | GetEnumValuesByName (const Char *name, const IAttributes *params, const Enum< EnumType > &enumClass, Array< EnumType > &values, Bool &error, Bool clear=true) const |
Get the enumeration values of an attribute by name at level 0. More... | |
template<class EnumType > | |
Bool | GetEnumValuesByName (const Char *name, const IAttributes *params, const Enum< EnumType > &enumClass, Array< EnumType > &values, Result &result, Bool clear=true) const |
Get the enumeration values of an attribute by name at level 0. More... | |
template<class EnumType > | |
Bool | GetEnumBitsToSetByName (const Char *name, const IAttributes *params, const Enum< EnumType > &enumClass, UInt32 &value, Bool &error) const |
Get the enumerated bit number values of an attribute by name at level 0 and set the bits. More... | |
template<class EnumType > | |
Bool | GetEnumBitsToSetByName (const Char *name, const IAttributes *params, const Enum< EnumType > &enumClass, UInt32 &value, Result &result) const |
Get the enumerated bit number values of an attribute by name at level 0 and set the bits. More... | |
Detailed Description
The XML attributes interface.
The attributes interface provides XML attributes name and value information.
Names can be separated by a "dot syntax" e.g. position.x="14" position.y="15"
.
Attribute can use multiple values separated by "," e.g. digits="one, two, three"
.
Attribute values can be substituted by using attribute names in braces e.g. size="{myAttribute}"
.
Member Function Documentation
◆ Clear()
|
pure virtual |
Clear all attributes.
- Returns
- true if successful.
◆ AddDefaults()
|
pure virtual |
Add a set of default attributes for named queries.
- Parameters
-
defaultAttributes The default attributes object to add.
- Returns
- true if successful, false if the given object was already added or the container does not allow to add defaults.
◆ GetNumberOfDefaults()
|
pure virtual |
Get the number of default attribute sets added via AddDefaults().
- Returns
- The number of default attribute sets.
◆ GetDefaults()
|
pure virtual |
Get the default attribute set at a given index.
- Parameters
-
index The index, from 0 to GetNumberOfDefaults()-1.
- Returns
- The default attribute set, or null if index is out of range.
◆ AddAttribute()
|
pure virtual |
Add a single attribute name and value.
- Parameters
-
fullName The full name of the attribute (including the dots). value The value of the attribute.
- Returns
- true if successful, false if the name already exists.
◆ SetAttribute()
|
pure virtual |
Set a value for a named attribute.
Sets the attribute to unused state.
- Parameters
-
fullName The full name of the attribute (including the dots). value The value of the attribute.
- Returns
- true if successful, false if the name does not exist.
◆ GetNumberOfAttributes()
|
pure virtual |
Get the number of attributes.
Attributes are organized using an index and a level number to support the "dot syntax" native.
e.g. a="7" e.f="9" b.c.d="8" e.g="10"
- The number of attributes is 6.
- "a" has index 0 and level 0, value is "7".
- "e" has index 1 and level 0, value is "null".
- "f" has index 2 and level 1, value is "9".
- "b" has index 3 and level 0, value is null.
- "c" has index 4 and level 1, value is null.
- "d" has index 5 and level 2, value is "8".
- "g" has index 6 and level 1, value is "10".
The parents can be accessed by decreasing the level.
- "b" can be found at index 4 and level 0.
- "b" can be found at index 5 and level 0.
- "c" can be found at index 5 and level 1.
- "e" can be found at index 2 and level 0.
- "e" can be found at index 6 and level 0.
- Returns
- The number of attributes.
◆ GetAttributeHash()
|
pure virtual |
Get the hash of an attribute name.
- Parameters
-
index The index of the attribute. level The level of the attribute.
- Returns
- The hash value of the attribute name.
◆ GetAttributeName()
|
pure virtual |
Get the name of an attribute.
- Parameters
-
index The index of the attribute. level The level of the attribute.
- Returns
- The name of the attribute or null if index / level is out of range.
◆ GetAttributeValue()
|
pure virtual |
Get the value of an attribute.
- Parameters
-
index The index of the attribute. level The level of the attribute.
- Returns
- The value of the attribute or null if the attribute has no value or if index / level is out of range.
◆ GetFullAttributeName()
Get the full name of an attribute.
The full name includes all parent attributes separated by dots.
- Parameters
-
index The index of the attribute.
- Returns
- The name of the attribute or an empty string if index is out of range.
◆ GetFullAttributeValue()
Get the value of an attribute (ignoring the level).
- Parameters
-
index The index of the attribute.
- Returns
- The value of the attribute or null if the attribute has no value or if index is out of range.
◆ GetAttributeIndex()
|
pure virtual |
Get the index of an attribute name at level 0.
- Parameters
-
name The name of the attribute.
- Returns
- The index of the attribute or -1 if the name at level 0 does not exist.
Referenced by GetEnumBitsToSetByName(), GetEnumValueByName(), and GetEnumValuesByName().
◆ GetFullAttributeIndex()
|
pure virtual |
Get the index of a fully qualified attribute.
- Parameters
-
fullName The full name of the attribute, including separating dots.
- Returns
- The index of the attribute or -1 if the given name does not exist.
◆ GetAttributeParent()
Get the parent index of an attribute.
- Parameters
-
index The index of the attribute.
- Returns
- The parent index of the attribute or -1 if the attribute has no parent or if index is out of range.
◆ GetAttributeLevel()
Get the level of an attribute.
- Parameters
-
index The index of the attribute.
- Returns
- The level of the attribute.
◆ IsAttributeUsed()
Check if the attribute is used.
The attribute used state is set when calling one if the GetValue...() methods was successful.
- Parameters
-
index The index of the attribute.
- Returns
- true if the attribute is used.
◆ HasAttributeValue()
Check if the attribute has a value.
- Parameters
-
index The index of the attribute.
- Returns
- true if the attribute has a value.
◆ GetNumberOfUnusedAttributes()
|
pure virtual |
Get the number of unused attributes.
- Returns
- The number of unused attributes.
◆ GetUnusedAttributeNames()
|
pure virtual |
Get the names of unused attributes.
- Parameters
-
names The string array to add the names.
- Returns
- true if names were added.
◆ SetAllAttributesUsed()
|
pure virtual |
Set all attributes to used state.
- Returns
- true if successful.
◆ EvaluateExpression() [1/2]
|
pure virtual |
Evaluate an expression string.
- Parameters
-
expression The expression string to evaluate. value A reference to a string receiving the result if successful. error The error return value is set to true if evaluation failed.
- Returns
- true if successful.
◆ EvaluateExpression() [2/2]
|
pure virtual |
Evaluate an expression string.
- Parameters
-
expression The expression string to evaluate. value A reference to a string receiving the result if successful. result An error message is appended to this object if evaluation failed.
- Returns
- true if successful.
◆ GetValueByIndex() [1/14]
|
pure virtual |
Get the string value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The string return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Referenced by GetEnumValueByIndex().
◆ GetValueByIndex() [2/14]
|
pure virtual |
Get the boolean value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The boolean return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [3/14]
|
pure virtual |
Get the unsigned integer value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The unsigned integer return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [4/14]
|
pure virtual |
Get the signed integer value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The signed integer return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [5/14]
|
pure virtual |
Get the double value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The double return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [6/14]
|
pure virtual |
Get the float value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The float return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [7/14]
|
pure virtual |
Get the color value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The color return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [8/14]
|
pure virtual |
Get the string value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The string return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [9/14]
|
pure virtual |
Get the boolean value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The boolean return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [10/14]
|
pure virtual |
Get the unsigned integer value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The unsigned integer return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [11/14]
|
pure virtual |
Get the signed integer value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The signed integer return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [12/14]
|
pure virtual |
Get the double value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The double return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [13/14]
|
pure virtual |
Get the float value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The float return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByIndex() [14/14]
|
pure virtual |
Get the color value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The color return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValueByIndex() [1/4]
|
pure virtual |
Get the angle double value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The angle double return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValueByIndex() [2/4]
|
pure virtual |
Get the angle float value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The angle float return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetColorValueByIndex() [1/2]
|
pure virtual |
Get the color component value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The color component return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValueByIndex() [3/4]
|
pure virtual |
Get the angle double value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The angle double return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValueByIndex() [4/4]
|
pure virtual |
Get the angle float value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The angle float return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetColorValueByIndex() [2/2]
|
pure virtual |
Get the color component value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The color component return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [1/24]
|
pure virtual |
Get the string values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The string array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
Referenced by GetEnumBitsToSetByIndex(), and GetEnumValuesByIndex().
◆ GetValuesByIndex() [2/24]
|
pure virtual |
Get the boolean values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The boolean array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [3/24]
|
pure virtual |
Get the unsigned integer values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The unsigned integer array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [4/24]
|
pure virtual |
Get the signed integer values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The signed integer array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [5/24]
|
pure virtual |
Get the double values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The double array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [6/24]
|
pure virtual |
Get the float values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The float array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [7/24]
|
pure virtual |
Get the string values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The string array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [8/24]
|
pure virtual |
Get the boolean values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The boolean array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [9/24]
|
pure virtual |
Get the unsigned integer values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The unsigned integer array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [10/24]
|
pure virtual |
Get the signed integer values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The signed integer array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [11/24]
|
pure virtual |
Get the double values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The double array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [12/24]
|
pure virtual |
Get the float values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The float array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByIndex() [1/8]
|
pure virtual |
Get the double angle values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The double array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByIndex() [2/8]
|
pure virtual |
Get the float angle values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The float array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByIndex() [3/8]
|
pure virtual |
Get the double angle values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The double array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByIndex() [4/8]
|
pure virtual |
Get the float angle values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values The float array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [13/24]
|
pure virtual |
Get the String values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of String objects to receive the return values. maxValues The capacity of the raw array. error The error return value is set to true if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [14/24]
|
pure virtual |
Get the boolean values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of Bool values to receive the return values. maxValues The capacity of the raw array. error The error return value is set to true if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [15/24]
|
pure virtual |
Get the unsigned integer values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of UInt32 values to receive the return values. maxValues The capacity of the raw array. error The error return value is set to true if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [16/24]
|
pure virtual |
Get the signed integer values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of SInt32 values to receive the return values. maxValues The capacity of the raw array. error The error return value is set to true if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [17/24]
|
pure virtual |
Get the double values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of double values to receive the return values. maxValues The capacity of the raw array. error The error return value is set to true if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [18/24]
|
pure virtual |
Get the float values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of float values to receive the return values. maxValues The capacity of the raw array. error The error return value is set to true if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [19/24]
|
pure virtual |
Get the String values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of String objects to receive the return values. maxValues The capacity of the raw array. result An error message is appended to this object if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [20/24]
|
pure virtual |
Get the boolean values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of Bool values to receive the return values. maxValues The capacity of the raw array. result An error message is appended to this object if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [21/24]
|
pure virtual |
Get the unsigned integer values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of UInt32 values to receive the return values. maxValues The capacity of the raw array. result An error message is appended to this object if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [22/24]
|
pure virtual |
Get the signed integer values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of SInt32 values to receive the return values. maxValues The capacity of the raw array. result An error message is appended to this object if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [23/24]
|
pure virtual |
Get the double values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of double values to receive the return values. maxValues The capacity of the raw array. result An error message is appended to this object if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByIndex() [24/24]
|
pure virtual |
Get the float values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of float values to receive the return values. maxValues The capacity of the raw array. result An error message is appended to this object if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByIndex() [5/8]
|
pure virtual |
Get the double angle values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of double values to receive the return values. maxValues The capacity of the raw array. error The error return value is set to true if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByIndex() [6/8]
|
pure virtual |
Get the float angle values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of float values to receive the return values. maxValues The capacity of the raw array. error The error return value is set to true if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByIndex() [7/8]
|
pure virtual |
Get the double angle values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of double values to receive the return values. maxValues The capacity of the raw array. result An error message is appended to this object if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByIndex() [8/8]
|
pure virtual |
Get the float angle values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. values A pointer to a raw array of float values to receive the return values. maxValues The capacity of the raw array. result An error message is appended to this object if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetBitsToSetByIndex() [1/2]
|
pure virtual |
Get the bit number values of an attribute by index and set the bits.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The bits return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetBitsToSetByIndex() [2/2]
|
pure virtual |
Get the bit number values of an attribute by index and set the bits.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. value The bits return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetEnumValueByIndex() [1/2]
|
inline |
Get the enumeration value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. value The enumeration return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References Murl::Enum< EnumType >::GetEnumValueByName(), and GetValueByIndex().
Referenced by Murl::Graph::IDeserializeAttributeTracker::GetAttributeEnumValue(), and GetEnumValueByName().
◆ GetEnumValueByIndex() [2/2]
|
inline |
Get the enumeration value of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. value The enumeration return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References Murl::Result::Append(), Murl::String::Begin(), Murl::Enum< EnumType >::GetEnumValueByName(), GetValueByIndex(), and Murl::IEnums::RESULT_CODE_ATTRIBUTE_ENUM_CONVERSION_ERROR.
◆ GetEnumValuesByIndex() [1/4]
|
inline |
Get the enumeration values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. values The enumeration array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References Murl::Array< DataType >::Add(), Murl::Array< DataType >::GetCount(), Murl::Enum< EnumType >::GetEnumValueByName(), and GetValuesByIndex().
Referenced by Murl::Graph::IDeserializeAttributeTracker::GetAttributeEnumValues(), and GetEnumValuesByName().
◆ GetEnumValuesByIndex() [2/4]
|
inline |
Get the enumeration values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. values A pointer to a raw array of enum variables to receive the return values. maxValues The capacity of the raw array. error The error return value is set to true if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References Murl::Array< DataType >::GetCount(), Murl::Enum< EnumType >::GetEnumValueByName(), GetValuesByIndex(), and Murl::Math::Min().
◆ GetEnumValuesByIndex() [3/4]
|
inline |
Get the enumeration values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. values The enumeration array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References Murl::Array< DataType >::Add(), Murl::Result::Append(), Murl::Array< DataType >::GetCount(), Murl::Enum< EnumType >::GetEnumValueByName(), GetValuesByIndex(), and Murl::IEnums::RESULT_CODE_ATTRIBUTE_ENUM_CONVERSION_ERROR.
◆ GetEnumValuesByIndex() [4/4]
|
inline |
Get the enumeration values of an attribute by index.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. values A pointer to a raw array of enum variables to receive the return values. maxValues The capacity of the raw array. result An error message is appended to this object if data conversion failed. numValues An optional pointer to a variable receiving the number of return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References Murl::Result::Append(), Murl::Array< DataType >::GetCount(), Murl::Enum< EnumType >::GetEnumValueByName(), GetValuesByIndex(), Murl::Math::Min(), and Murl::IEnums::RESULT_CODE_ATTRIBUTE_ENUM_CONVERSION_ERROR.
◆ GetEnumBitsToSetByIndex() [1/2]
|
inline |
Get the enumerated bit number values of an attribute by index and set the bits.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. value The bits return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References Murl::Array< DataType >::GetCount(), Murl::Enum< EnumType >::GetEnumValueByName(), and GetValuesByIndex().
Referenced by Murl::Graph::IDeserializeAttributeTracker::GetAttributeEnumBitsToSet(), and GetEnumBitsToSetByName().
◆ GetEnumBitsToSetByIndex() [2/2]
|
inline |
Get the enumerated bit number values of an attribute by index and set the bits.
- Parameters
-
index The index of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. value The bits return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References Murl::Result::Append(), Murl::Array< DataType >::GetCount(), Murl::Enum< EnumType >::GetEnumValueByName(), GetValuesByIndex(), and Murl::IEnums::RESULT_CODE_ATTRIBUTE_ENUM_CONVERSION_ERROR.
◆ GetValueByName() [1/14]
|
pure virtual |
Get the string value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The string return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [2/14]
|
pure virtual |
Get the boolean value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The boolean return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [3/14]
|
pure virtual |
Get the unsigned integer value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The unsigned integer return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [4/14]
|
pure virtual |
Get the signed integer value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The signed integer return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [5/14]
|
pure virtual |
Get the double value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The double return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [6/14]
|
pure virtual |
Get the float value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The float return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [7/14]
|
pure virtual |
Get the color value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The color return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [8/14]
|
pure virtual |
Get the string value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The string return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [9/14]
|
pure virtual |
Get the boolean value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The boolean return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [10/14]
|
pure virtual |
Get the unsigned integer value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The unsigned integer return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [11/14]
|
pure virtual |
Get the signed integer value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The signed integer return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [12/14]
|
pure virtual |
Get the double value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The double return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [13/14]
|
pure virtual |
Get the float value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The float return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValueByName() [14/14]
|
pure virtual |
Get the color value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The color return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValueByName() [1/4]
|
pure virtual |
Get the angle double value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The angle double return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValueByName() [2/4]
|
pure virtual |
Get the angle float value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The angle float return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetColorValueByName() [1/2]
|
pure virtual |
Get the color component value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The color component return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValueByName() [3/4]
|
pure virtual |
Get the angle double value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The angle double return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValueByName() [4/4]
|
pure virtual |
Get the angle float value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The angle float return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetColorValueByName() [2/2]
|
pure virtual |
Get the color component value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The color component return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [1/12]
|
pure virtual |
Get the string values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The string array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [2/12]
|
pure virtual |
Get the boolean values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The boolean array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [3/12]
|
pure virtual |
Get the unsigned integer values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The unsigned integer array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [4/12]
|
pure virtual |
Get the signed integer values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The signed integer array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [5/12]
|
pure virtual |
Get the double values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The double array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [6/12]
|
pure virtual |
Get the float values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The float array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [7/12]
|
pure virtual |
Get the string values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The string array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [8/12]
|
pure virtual |
Get the boolean values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The boolean array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [9/12]
|
pure virtual |
Get the unsigned integer values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The unsigned integer array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [10/12]
|
pure virtual |
Get the signed integer values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The signed integer array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [11/12]
|
pure virtual |
Get the double values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The double array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetValuesByName() [12/12]
|
pure virtual |
Get the float values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The float array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByName() [1/4]
|
pure virtual |
Get the double angle values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The double array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByName() [2/4]
|
pure virtual |
Get the float angle values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The float array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByName() [3/4]
|
pure virtual |
Get the double angle values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The double array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetAngleValuesByName() [4/4]
|
pure virtual |
Get the float angle values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. values The float array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetBitsToSetByName() [1/2]
|
pure virtual |
Get the bit number values of an attribute by name at level 0 and set the bits.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The bits return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetBitsToSetByName() [2/2]
|
pure virtual |
Get the bit number values of an attribute by name at level 0 and set the bits.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. value The bits return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
◆ GetEnumValueByName() [1/2]
|
inline |
Get the enumeration value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. value The enumeration return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References GetAttributeIndex(), and GetEnumValueByIndex().
◆ GetEnumValueByName() [2/2]
|
inline |
Get the enumeration value of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. value The enumeration return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References GetAttributeIndex(), and GetEnumValueByIndex().
◆ GetEnumValuesByName() [1/2]
|
inline |
Get the enumeration values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. values The enumeration array return value. error The error return value is set to true if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References GetAttributeIndex(), and GetEnumValuesByIndex().
◆ GetEnumValuesByName() [2/2]
|
inline |
Get the enumeration values of an attribute by name at level 0.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. values The enumeration array return value. result An error message is appended to this object if data conversion failed. clear If true clear the return value array before adding the return values.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References GetAttributeIndex(), and GetEnumValuesByIndex().
◆ GetEnumBitsToSetByName() [1/2]
|
inline |
Get the enumerated bit number values of an attribute by name at level 0 and set the bits.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. value The bits return value. error The error return value is set to true if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References GetAttributeIndex(), and GetEnumBitsToSetByIndex().
◆ GetEnumBitsToSetByName() [2/2]
|
inline |
Get the enumerated bit number values of an attribute by name at level 0 and set the bits.
- Parameters
-
name The name of the attribute. params The attributes for value substitution inside curly braces or null. enumClass The enumeration class for looking up the value. value The bits return value. result An error message is appended to this object if data conversion failed.
- Returns
- true if successful, false if the attribute index is out of range or if the attribute has no value or if error is true.
References GetAttributeIndex(), and GetEnumBitsToSetByIndex().
The documentation for this interface was generated from the following file:
- murl_i_attributes.h