Murl::IAttributes Interface Referenceabstract

The XML attributes interface. More...

#include "murl_i_attributes.h"

Inheritance diagram for Murl::IAttributes:

Public Member Functions

virtual ~IAttributes ()
 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 IAttributesGetDefaults (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 CharGetAttributeName (UInt32 index, UInt32 level=0) const =0
 Get the name of an attribute. More...
 
virtual const CharGetAttributeValue (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 CharGetFullAttributeValue (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 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 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 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 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 GetValuesByIndex (UInt32 index, const IAttributes *params, String *values, UInt32 maxValues, Bool &error, UInt32 *numValues=0) 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=0) 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=0) 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=0) 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=0) 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=0) 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=0) 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=0) 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...
 
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 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=0) 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...
 
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 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 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 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 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...
 
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 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 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...
 

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 substitued by using attribute names in braces e.g. size="{myAttribute}".

Member Function Documentation

◆ Clear()

virtual Bool Murl::IAttributes::Clear ( )
pure virtual

Clear all attributes.

Returns
true if successful.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ AddDefaults()

virtual Bool Murl::IAttributes::AddDefaults ( const IAttributes defaultAttributes)
pure virtual

Add a set of default attributes for named queries.

Parameters
defaultAttributesThe 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.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetNumberOfDefaults()

virtual UInt32 Murl::IAttributes::GetNumberOfDefaults ( ) const
pure virtual

Get the number of default attribute sets added via AddDefaults().

Returns
The number of default attribute sets.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetDefaults()

virtual const IAttributes* Murl::IAttributes::GetDefaults ( UInt32  index) const
pure virtual

Get the default attribute set at a given index.

Parameters
indexThe index, from 0 to GetNumberOfDefaults()-1.
Returns
The default attribute set, or null if index is out of range.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ AddAttribute()

virtual Bool Murl::IAttributes::AddAttribute ( const String fullName,
const String value 
)
pure virtual

Add a single attribute name and value.

Parameters
fullNameThe full name of the attribute (including the dots).
valueThe value of the attribute.
Returns
true if successful, false if the name already exists.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ SetAttribute()

virtual Bool Murl::IAttributes::SetAttribute ( const String fullName,
const String value 
)
pure virtual

Set a value for a named attribute.

Sets the attribute to unused state.

Parameters
fullNameThe full name of the attribute (including the dots).
valueThe value of the attribute.
Returns
true if successful, false if the name does not exist.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetNumberOfAttributes()

virtual UInt32 Murl::IAttributes::GetNumberOfAttributes ( ) const
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.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetAttributeHash()

virtual UInt32 Murl::IAttributes::GetAttributeHash ( UInt32  index,
UInt32  level = 0 
) const
pure virtual

Get the hash of an attribute name.

Parameters
indexThe index of the attribute.
levelThe level of the attribute.
Returns
The hash value of the attribute name.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetAttributeName()

virtual const Char* Murl::IAttributes::GetAttributeName ( UInt32  index,
UInt32  level = 0 
) const
pure virtual

Get the name of an attribute.

Parameters
indexThe index of the attribute.
levelThe level of the attribute.
Returns
The name of the attribute or null if index / level is out of range.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetAttributeValue()

virtual const Char* Murl::IAttributes::GetAttributeValue ( UInt32  index,
UInt32  level = 0 
) const
pure virtual

Get the value of an attribute.

Parameters
indexThe index of the attribute.
levelThe 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.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetFullAttributeName()

virtual String Murl::IAttributes::GetFullAttributeName ( UInt32  index) const
pure virtual

Get the full name of an attribute.

The full name includes all parent attributes separated by dots.

Parameters
indexThe index of the attribute.
Returns
The name of the attribute or an empty string if index is out of range.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetFullAttributeValue()

virtual const Char* Murl::IAttributes::GetFullAttributeValue ( UInt32  index) const
pure virtual

Get the value of an attribute (ignoring the level).

Parameters
indexThe 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.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetAttributeIndex()

virtual SInt32 Murl::IAttributes::GetAttributeIndex ( const char *  name) const
pure virtual

Get the index of an attribute name at level 0.

Parameters
nameThe name of the attribute.
Returns
The index of the attribute or -1 if the name at level 0 does not exist.

Implemented in Murl::Util::Attributes.

Referenced by GetEnumBitsToSetByName(), GetEnumValueByName(), GetEnumValuesByName(), and ~IAttributes().

◆ GetFullAttributeIndex()

virtual SInt32 Murl::IAttributes::GetFullAttributeIndex ( const char *  fullName) const
pure virtual

Get the index of a fully qualified attribute.

Parameters
fullNameThe full name of the attribute, including separating dots.
Returns
The index of the attribute or -1 if the given name does not exist.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetAttributeParent()

virtual SInt32 Murl::IAttributes::GetAttributeParent ( UInt32  index) const
pure virtual

Get the parent index of an attribute.

Parameters
indexThe 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.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetAttributeLevel()

virtual UInt32 Murl::IAttributes::GetAttributeLevel ( UInt32  index) const
pure virtual

Get the level of an attribute.

Parameters
indexThe index of the attribute.
Returns
The level of the attribute.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ IsAttributeUsed()

virtual Bool Murl::IAttributes::IsAttributeUsed ( UInt32  index) const
pure virtual

Check if the attribute is used.

The attribute used state is set when calling one if the GetValue...() methods was successful.

Parameters
indexThe index of the attribute.
Returns
true if the attribute is used.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ HasAttributeValue()

virtual Bool Murl::IAttributes::HasAttributeValue ( UInt32  index) const
pure virtual

Check if the attribute has a value.

Parameters
indexThe index of the attribute.
Returns
true if the attribute has a value.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetNumberOfUnusedAttributes()

virtual UInt32 Murl::IAttributes::GetNumberOfUnusedAttributes ( ) const
pure virtual

Get the number of unused attributes.

Returns
The number of unused attributes.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetUnusedAttributeNames()

virtual Bool Murl::IAttributes::GetUnusedAttributeNames ( StringArray names) const
pure virtual

Get the names of unused attributes.

Parameters
namesThe string array to add the names.
Returns
true if names were added.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ SetAllAttributesUsed()

virtual Bool Murl::IAttributes::SetAllAttributesUsed ( ) const
pure virtual

Set all attributes to used state.

Returns
true if successful.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ EvaluateExpression()

virtual Bool Murl::IAttributes::EvaluateExpression ( const Char expression,
String value,
Bool error 
) const
pure virtual

Evaluate an expression string.

Parameters
expressionThe expression string to evaluate.
valueA reference to a string receiving the result if successful.
errorThe error return value is set to true if evaluation failed.
Returns
true if successful.

Implemented in Murl::Util::AttributesBase.

Referenced by ~IAttributes().

◆ GetValueByIndex() [1/7]

virtual Bool Murl::IAttributes::GetValueByIndex ( UInt32  index,
const IAttributes params,
String value,
Bool error 
) const
pure virtual

Get the string value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe string return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

Referenced by GetEnumValueByIndex(), and ~IAttributes().

◆ GetValueByIndex() [2/7]

virtual Bool Murl::IAttributes::GetValueByIndex ( UInt32  index,
const IAttributes params,
Bool value,
Bool error 
) const
pure virtual

Get the boolean value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe boolean return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

◆ GetValueByIndex() [3/7]

virtual Bool Murl::IAttributes::GetValueByIndex ( UInt32  index,
const IAttributes params,
UInt32 value,
Bool error 
) const
pure virtual

Get the unsigned integer value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe unsigned integer return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

◆ GetValueByIndex() [4/7]

virtual Bool Murl::IAttributes::GetValueByIndex ( UInt32  index,
const IAttributes params,
SInt32 value,
Bool error 
) const
pure virtual

Get the signed integer value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe signed integer return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

◆ GetValueByIndex() [5/7]

virtual Bool Murl::IAttributes::GetValueByIndex ( UInt32  index,
const IAttributes params,
Double value,
Bool error 
) const
pure virtual

Get the double value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe double return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

◆ GetValueByIndex() [6/7]

virtual Bool Murl::IAttributes::GetValueByIndex ( UInt32  index,
const IAttributes params,
Float value,
Bool error 
) const
pure virtual

Get the float value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe float return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

◆ GetValueByIndex() [7/7]

virtual Bool Murl::IAttributes::GetValueByIndex ( UInt32  index,
const IAttributes params,
Color value,
Bool error 
) const
pure virtual

Get the color value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

◆ GetAngleValueByIndex() [1/2]

virtual Bool Murl::IAttributes::GetAngleValueByIndex ( UInt32  index,
const IAttributes params,
Double value,
Bool error 
) const
pure virtual

Get the angle double value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe angle double return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetAngleValueByIndex() [2/2]

virtual Bool Murl::IAttributes::GetAngleValueByIndex ( UInt32  index,
const IAttributes params,
Float value,
Bool error 
) const
pure virtual

Get the angle float value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe angle float return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

◆ GetColorValueByIndex()

virtual Bool Murl::IAttributes::GetColorValueByIndex ( UInt32  index,
const IAttributes params,
Float value,
Bool error 
) const
pure virtual

Get the color component value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color component return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetValuesByIndex() [1/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
StringArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the string values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe string array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes.

Referenced by GetEnumBitsToSetByIndex(), GetEnumValuesByIndex(), and ~IAttributes().

◆ GetValuesByIndex() [2/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
BoolArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the boolean values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe boolean array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [3/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
UInt32Array values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the unsigned integer values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe unsigned integer array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [4/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
SInt32Array values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the signed integer values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe signed integer array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [5/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
DoubleArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the double values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [6/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
FloatArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the float values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes.

◆ GetAngleValuesByIndex() [1/4]

virtual Bool Murl::IAttributes::GetAngleValuesByIndex ( UInt32  index,
const IAttributes params,
DoubleArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the double angle values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetAngleValuesByIndex() [2/4]

virtual Bool Murl::IAttributes::GetAngleValuesByIndex ( UInt32  index,
const IAttributes params,
FloatArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the float angle values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [7/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
String values,
UInt32  maxValues,
Bool error,
UInt32 numValues = 0 
) const
pure virtual

Get the String values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesA pointer to a raw array of String objects to receive the return values.
maxValuesThe capacity of the raw array.
errorThe error return value is set to true if data conversion failed.
numValuesAn 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [8/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
Bool values,
UInt32  maxValues,
Bool error,
UInt32 numValues = 0 
) const
pure virtual

Get the boolean values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesA pointer to a raw array of boolean values to receive the return values.
maxValuesThe capacity of the raw boolean array.
errorThe error return value is set to true if data conversion failed.
numValuesAn 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [9/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
UInt32 values,
UInt32  maxValues,
Bool error,
UInt32 numValues = 0 
) const
pure virtual

Get the unsigned integer values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesA pointer to a raw array of UInt32 values to receive the return values.
maxValuesThe capacity of the raw UInt32 array.
errorThe error return value is set to true if data conversion failed.
numValuesAn 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [10/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
SInt32 values,
UInt32  maxValues,
Bool error,
UInt32 numValues = 0 
) const
pure virtual

Get the signed integer values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesA pointer to a raw array of SInt32 values to receive the return values.
maxValuesThe capacity of the raw SInt32 array.
errorThe error return value is set to true if data conversion failed.
numValuesAn 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [11/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
Double values,
UInt32  maxValues,
Bool error,
UInt32 numValues = 0 
) const
pure virtual

Get the double values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesA pointer to a raw array of double values to receive the return values.
maxValuesThe capacity of the raw double array.
errorThe error return value is set to true if data conversion failed.
numValuesAn 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.

Implemented in Murl::Util::Attributes.

◆ GetValuesByIndex() [12/12]

virtual Bool Murl::IAttributes::GetValuesByIndex ( UInt32  index,
const IAttributes params,
Float values,
UInt32  maxValues,
Bool error,
UInt32 numValues = 0 
) const
pure virtual

Get the float values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesA pointer to a raw array of float values to receive the return values.
maxValuesThe capacity of the raw float array.
errorThe error return value is set to true if data conversion failed.
numValuesAn 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.

Implemented in Murl::Util::Attributes.

◆ GetAngleValuesByIndex() [3/4]

virtual Bool Murl::IAttributes::GetAngleValuesByIndex ( UInt32  index,
const IAttributes params,
Double values,
UInt32  maxValues,
Bool error,
UInt32 numValues = 0 
) const
pure virtual

Get the double angle values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesA pointer to a raw array of double values to receive the return values.
maxValuesThe capacity of the raw double array.
errorThe error return value is set to true if data conversion failed.
numValuesAn 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.

Implemented in Murl::Util::Attributes.

◆ GetAngleValuesByIndex() [4/4]

virtual Bool Murl::IAttributes::GetAngleValuesByIndex ( UInt32  index,
const IAttributes params,
Float values,
UInt32  maxValues,
Bool error,
UInt32 numValues = 0 
) const
pure virtual

Get the float angle values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesA pointer to a raw array of float values to receive the return values.
maxValuesThe capacity of the raw float array.
errorThe error return value is set to true if data conversion failed.
numValuesAn 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.

Implemented in Murl::Util::Attributes.

◆ GetBitsToSetByIndex()

virtual Bool Murl::IAttributes::GetBitsToSetByIndex ( UInt32  index,
const IAttributes params,
UInt32 value,
Bool error 
) const
pure virtual

Get the bit number values of an attribute by index and set the bits.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe bits return value.
errorThe 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.

Implemented in Murl::Util::Attributes.

Referenced by ~IAttributes().

◆ GetEnumValueByIndex()

template<class EnumType >
Bool Murl::IAttributes::GetEnumValueByIndex ( UInt32  index,
const IAttributes params,
const Enum< EnumType > &  enumClass,
EnumType &  value,
Bool error 
) const
inline

Get the enumeration value of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
enumClassThe enumeration class for looking up the value.
valueThe enumeration return value.
errorThe 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().

◆ GetEnumValuesByIndex() [1/2]

template<class EnumType >
Bool Murl::IAttributes::GetEnumValuesByIndex ( UInt32  index,
const IAttributes params,
const Enum< EnumType > &  enumClass,
Array< EnumType > &  values,
Bool error,
Bool  clear = true 
) const
inline

Get the enumeration values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
enumClassThe enumeration class for looking up the value.
valuesThe enumeration array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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 >::Clear(), Murl::Array< DataType >::GetCount(), Murl::Enum< EnumType >::GetEnumValueByName(), and GetValuesByIndex().

Referenced by Murl::Graph::IDeserializeAttributeTracker::GetAttributeEnumValues(), and GetEnumValuesByName().

◆ GetEnumValuesByIndex() [2/2]

template<class EnumType >
Bool Murl::IAttributes::GetEnumValuesByIndex ( UInt32  index,
const IAttributes params,
const Enum< EnumType > &  enumClass,
EnumType *  values,
UInt32  maxValues,
Bool error,
UInt32 numValues = 0 
) const
inline

Get the enumeration values of an attribute by index.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
enumClassThe enumeration class for looking up the value.
valuesA pointer to a raw array of enum variables to receive the return values.
maxValuesThe capacity of the raw array.
errorThe error return value is set to true if data conversion failed.
numValuesAn 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().

◆ GetEnumBitsToSetByIndex()

template<class EnumType >
Bool Murl::IAttributes::GetEnumBitsToSetByIndex ( UInt32  index,
const IAttributes params,
const Enum< EnumType > &  enumClass,
UInt32 value,
Bool error 
) const
inline

Get the enumerated bit number values of an attribute by index and set the bits.

Parameters
indexThe index of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
enumClassThe enumeration class for looking up the value.
valueThe bits return value.
errorThe 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 GetAngleValueByName(), GetAngleValuesByName(), GetBitsToSetByName(), GetColorValueByName(), Murl::Array< DataType >::GetCount(), Murl::Enum< EnumType >::GetEnumValueByName(), GetValueByName(), GetValuesByIndex(), and GetValuesByName().

Referenced by Murl::Graph::IDeserializeAttributeTracker::GetAttributeEnumBitsToSet(), and GetEnumBitsToSetByName().

◆ GetValueByName() [1/7]

virtual Bool Murl::IAttributes::GetValueByName ( const Char name,
const IAttributes params,
String value,
Bool error 
) const
pure virtual

Get the string value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe string return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

Referenced by GetEnumBitsToSetByIndex().

◆ GetValueByName() [2/7]

virtual Bool Murl::IAttributes::GetValueByName ( const Char name,
const IAttributes params,
Bool value,
Bool error 
) const
pure virtual

Get the boolean value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe boolean return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetValueByName() [3/7]

virtual Bool Murl::IAttributes::GetValueByName ( const Char name,
const IAttributes params,
UInt32 value,
Bool error 
) const
pure virtual

Get the unsigned integer value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe unsigned integer return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetValueByName() [4/7]

virtual Bool Murl::IAttributes::GetValueByName ( const Char name,
const IAttributes params,
SInt32 value,
Bool error 
) const
pure virtual

Get the signed integer value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe signed integer return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetValueByName() [5/7]

virtual Bool Murl::IAttributes::GetValueByName ( const Char name,
const IAttributes params,
Double value,
Bool error 
) const
pure virtual

Get the double value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe double return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetValueByName() [6/7]

virtual Bool Murl::IAttributes::GetValueByName ( const Char name,
const IAttributes params,
Float value,
Bool error 
) const
pure virtual

Get the float value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe float return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetValueByName() [7/7]

virtual Bool Murl::IAttributes::GetValueByName ( const Char name,
const IAttributes params,
Color value,
Bool error 
) const
pure virtual

Get the color value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetAngleValueByName() [1/2]

virtual Bool Murl::IAttributes::GetAngleValueByName ( const Char name,
const IAttributes params,
Double value,
Bool error 
) const
pure virtual

Get the angle double value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe angle double return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

Referenced by GetEnumBitsToSetByIndex().

◆ GetAngleValueByName() [2/2]

virtual Bool Murl::IAttributes::GetAngleValueByName ( const Char name,
const IAttributes params,
Float value,
Bool error 
) const
pure virtual

Get the angle float value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe angle float return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetColorValueByName()

virtual Bool Murl::IAttributes::GetColorValueByName ( const Char name,
const IAttributes params,
Float value,
Bool error 
) const
pure virtual

Get the color component value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe color component return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

Referenced by GetEnumBitsToSetByIndex().

◆ GetValuesByName() [1/6]

virtual Bool Murl::IAttributes::GetValuesByName ( const Char name,
const IAttributes params,
StringArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the string values of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe string array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

Referenced by GetEnumBitsToSetByIndex().

◆ GetValuesByName() [2/6]

virtual Bool Murl::IAttributes::GetValuesByName ( const Char name,
const IAttributes params,
BoolArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the boolean values of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe boolean array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetValuesByName() [3/6]

virtual Bool Murl::IAttributes::GetValuesByName ( const Char name,
const IAttributes params,
UInt32Array values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the unsigned integer values of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe unsigned integer array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetValuesByName() [4/6]

virtual Bool Murl::IAttributes::GetValuesByName ( const Char name,
const IAttributes params,
SInt32Array values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the signed integer values of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe signed integer array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetValuesByName() [5/6]

virtual Bool Murl::IAttributes::GetValuesByName ( const Char name,
const IAttributes params,
DoubleArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the double values of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetValuesByName() [6/6]

virtual Bool Murl::IAttributes::GetValuesByName ( const Char name,
const IAttributes params,
FloatArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the float values of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetAngleValuesByName() [1/2]

virtual Bool Murl::IAttributes::GetAngleValuesByName ( const Char name,
const IAttributes params,
DoubleArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the double angle values of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe double array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

Referenced by GetEnumBitsToSetByIndex().

◆ GetAngleValuesByName() [2/2]

virtual Bool Murl::IAttributes::GetAngleValuesByName ( const Char name,
const IAttributes params,
FloatArray values,
Bool error,
Bool  clear = true 
) const
pure virtual

Get the float angle values of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valuesThe float array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

◆ GetBitsToSetByName()

virtual Bool Murl::IAttributes::GetBitsToSetByName ( const Char name,
const IAttributes params,
UInt32 value,
Bool error 
) const
pure virtual

Get the bit number values of an attribute by name at level 0 and set the bits.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
valueThe bits return value.
errorThe 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.

Implemented in Murl::Util::Attributes, and Murl::Util::AttributesBase.

Referenced by GetEnumBitsToSetByIndex().

◆ GetEnumValueByName()

template<class EnumType >
Bool Murl::IAttributes::GetEnumValueByName ( const Char name,
const IAttributes params,
const Enum< EnumType > &  enumClass,
EnumType &  value,
Bool error 
) const
inline

Get the enumeration value of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
enumClassThe enumeration class for looking up the value.
valueThe enumeration return value.
errorThe 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().

◆ GetEnumValuesByName()

template<class EnumType >
Bool Murl::IAttributes::GetEnumValuesByName ( const Char name,
const IAttributes params,
const Enum< EnumType > &  enumClass,
Array< EnumType > &  values,
Bool error,
Bool  clear = true 
) const
inline

Get the enumeration values of an attribute by name at level 0.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
enumClassThe enumeration class for looking up the value.
valuesThe enumeration array return value.
errorThe error return value is set to true if data conversion failed.
clearIf 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()

template<class EnumType >
Bool Murl::IAttributes::GetEnumBitsToSetByName ( const Char name,
const IAttributes params,
const Enum< EnumType > &  enumClass,
UInt32 value,
Bool error 
) const
inline

Get the enumerated bit number values of an attribute by name at level 0 and set the bits.

Parameters
nameThe name of the attribute.
paramsThe attributes for value substituion inside curly braces or null.
enumClassThe enumeration class for looking up the value.
valueThe bits return value.
errorThe 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().


The documentation for this interface was generated from the following file:
  • murl_i_attributes.h


Copyright © 2011-2018 Spraylight GmbH.