Murl::Util::Attributes Class Reference

The attributes class, see IAttributes. More...

#include "murl_util_attributes.h"

Inheritance diagram for Murl::Util::Attributes:

Public Member Functions

 Attributes ()
 The default constructor.
 
 Attributes (const Char **attributes)
 Constructor taking a string array. More...
 
 Attributes (const IAttributes *other, Bool unusedOnly=false)
 Constructor copying attributes with option. More...
 
 Attributes (const IAttributes *base, const IAttributes *additional)
 Constructor copying attributes. More...
 
virtual ~Attributes ()
 The destructor.
 
virtual Bool Clear ()
 Implementation of IAttributes::Clear().
 
virtual Bool AddDefaults (const IAttributes *defaultAttributes)
 Implementation of IAttributes::AddDefaults(const IAttributes* defaultAttributes).
 
virtual UInt32 GetNumberOfDefaults () const
 Implementation of IAttributes::GetNumberOfDefaults() const.
 
virtual const IAttributesGetDefaults (UInt32 index) const
 Implementation of IAttributes::GetDefaults(UInt32 index) const.
 
virtual Bool AddAttribute (const String &fullName, const String &value)
 Implementation of IAttributes::AddAttribute(const String& fullName, const String& value).
 
virtual Bool SetAttribute (const String &fullName, const String &value)
 Implementation of IAttributes::SetAttribute(const String& fullName, const String& value).
 
virtual UInt32 GetNumberOfAttributes () const
 Implementation of IAttributes::GetNumberOfAttributes().
 
virtual UInt32 GetAttributeHash (UInt32 index, UInt32 level=0) const
 Implementation of IAttributes::GetAttributeHash().
 
virtual const CharGetAttributeName (UInt32 index, UInt32 level=0) const
 Implementation of IAttributes::GetAttributeName().
 
virtual const CharGetAttributeValue (UInt32 index, UInt32 level=0) const
 Implementation of IAttributes::GetAttributeValue().
 
virtual String GetFullAttributeName (UInt32 index) const
 Implementation of IAttributes::GetFullAttributeName().
 
virtual const CharGetFullAttributeValue (UInt32 index) const
 Implementation of IAttributes::GetFullAttributeValue().
 
virtual SInt32 GetAttributeIndex (const char *name) const
 Implementation of IAttributes::GetAttributeIndex().
 
virtual SInt32 GetFullAttributeIndex (const char *fullName) const
 Implementation of IAttributes::GetFullAttributeIndex().
 
virtual SInt32 GetAttributeParent (UInt32 index) const
 Implementation of IAttributes::GetAttributeParent().
 
virtual UInt32 GetAttributeLevel (UInt32 index) const
 Implementation of IAttributes::GetAttributeLevel().
 
virtual Bool IsAttributeUsed (UInt32 index) const
 Implementation of IAttributes::IsAttributeUsed().
 
virtual Bool HasAttributeValue (UInt32 index) const
 Implementation of IAttributes::HasAttributeValue().
 
virtual UInt32 GetNumberOfUnusedAttributes () const
 Implementation of IAttributes::GetNumberOfUnusedAttributesGetNumberOfUnusedAttributes().
 
virtual Bool GetUnusedAttributeNames (StringArray &names) const
 Implementation of IAttributes::GetUnusedAttributeNames().
 
virtual Bool SetAllAttributesUsed () const
 Implementation of IAttributes::SetAllAttributesUsed().
 
virtual Bool GetValueByIndex (UInt32 index, const IAttributes *params, String &value, Bool &error) const
 Implementation of IAttributes::GetValueByIndex(UInt32 index, const IAttributes* params, String& value, Bool& error) const.
 
virtual Bool GetValueByIndex (UInt32 index, const IAttributes *params, Bool &value, Bool &error) const
 Implementation of IAttributes::GetValueByIndex(UInt32 index, const IAttributes* params, Bool& value, Bool& error) const.
 
virtual Bool GetValueByIndex (UInt32 index, const IAttributes *params, UInt32 &value, Bool &error) const
 Implementation of IAttributes::GetValueByIndex(UInt32 index, const IAttributes* params, UInt32& value, Bool& error) const.
 
virtual Bool GetValueByIndex (UInt32 index, const IAttributes *params, SInt32 &value, Bool &error) const
 Implementation of IAttributes::GetValueByIndex(UInt32 index, const IAttributes* params, SInt32& value, Bool& error) const.
 
virtual Bool GetValueByIndex (UInt32 index, const IAttributes *params, Double &value, Bool &error) const
 Implementation of IAttributes::GetValueByIndex(UInt32 index, const IAttributes* params, Double& value, Bool& error) const.
 
virtual Bool GetValueByIndex (UInt32 index, const IAttributes *params, Float &value, Bool &error) const
 Implementation of IAttributes::GetValueByIndex(UInt32 index, const IAttributes* params, Float& value, Bool& error) const.
 
virtual Bool GetValueByIndex (UInt32 index, const IAttributes *params, Color &value, Bool &error) const
 Implementation of IAttributes::GetValueByIndex(UInt32 index, const IAttributes* params, Color& value, Bool& error) const.
 
virtual Bool GetAngleValueByIndex (UInt32 index, const IAttributes *params, Double &value, Bool &error) const
 Implementation of IAttributes::GetAngleValueByIndex(UInt32 index, const IAttributes* params, Double& value, Bool& error) const.
 
virtual Bool GetAngleValueByIndex (UInt32 index, const IAttributes *params, Float &value, Bool &error) const
 Implementation of IAttributes::GetAngleValueByIndex(UInt32 index, const IAttributes* params, Float& value, Bool& error) const.
 
virtual Bool GetColorValueByIndex (UInt32 index, const IAttributes *params, Float &value, Bool &error) const
 Implementation of IAttributes::GetColorValueByIndex(UInt32 index, const IAttributes* params, Float& value, Bool& error) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, StringArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, StringArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, BoolArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, BoolArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, UInt32Array &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, UInt32Array& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, SInt32Array &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, SInt32Array& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, DoubleArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, DoubleArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, FloatArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, FloatArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetAngleValuesByIndex (UInt32 index, const IAttributes *params, DoubleArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetAngleValuesByIndex(UInt32 index, const IAttributes* params, DoubleArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetAngleValuesByIndex (UInt32 index, const IAttributes *params, FloatArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetAngleValuesByIndex(UInt32 index, const IAttributes* params, FloatArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, String *values, UInt32 maxValues, Bool &error, UInt32 *numValues) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, String* values, UInt32 maxValues, Bool& error, UInt32* numValues) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, Bool *values, UInt32 maxValues, Bool &error, UInt32 *numValues) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, Bool* values, UInt32 maxValues, Bool& error, UInt32* numValues) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, UInt32 *values, UInt32 maxValues, Bool &error, UInt32 *numValues) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, UInt32* values, UInt32 maxValues, Bool& error, UInt32* numValues) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, SInt32 *values, UInt32 maxValues, Bool &error, UInt32 *numValues) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, SInt32* values, UInt32 maxValues, Bool& error, UInt32* numValues) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, Double *values, UInt32 maxValues, Bool &error, UInt32 *numValues) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, Double* values, UInt32 maxValues, Bool& error, UInt32* numValues) const.
 
virtual Bool GetValuesByIndex (UInt32 index, const IAttributes *params, Float *values, UInt32 maxValues, Bool &error, UInt32 *numValues) const
 Implementation of IAttributes::GetValuesByIndex(UInt32 index, const IAttributes* params, Float* values, UInt32 maxValues, Bool& error, UInt32* numValues) const.
 
virtual Bool GetAngleValuesByIndex (UInt32 index, const IAttributes *params, Double *values, UInt32 maxValues, Bool &error, UInt32 *numValues) const
 Implementation of IAttributes::GetAngleValuesByIndex(UInt32 index, const IAttributes* params, Double* values, UInt32 maxValues, Bool& error, UInt32* numValues) const.
 
virtual Bool GetAngleValuesByIndex (UInt32 index, const IAttributes *params, Float *values, UInt32 maxValues, Bool &error, UInt32 *numValues) const
 Implementation of IAttributes::GetAngleValuesByIndex(UInt32 index, const IAttributes* params, Float* values, UInt32 maxValues, Bool& error, UInt32* numValues) const.
 
virtual Bool GetBitsToSetByIndex (UInt32 index, const IAttributes *params, UInt32 &value, Bool &error) const
 Implementation of IAttributes::GetBitsToSetByIndex(UInt32 index, const IAttributes* params, UInt32& value, Bool& error) const.
 
virtual Bool GetValueByName (const Char *name, const IAttributes *params, String &value, Bool &error) const
 Implementation of IAttributes::GetValueByName(const Char* name, const IAttributes* params, String& value, Bool& error) const.
 
virtual Bool GetValueByName (const Char *name, const IAttributes *params, Bool &value, Bool &error) const
 Implementation of IAttributes::GetValueByName(const Char* name, const IAttributes* params, Bool& value, Bool& error) const.
 
virtual Bool GetValueByName (const Char *name, const IAttributes *params, UInt32 &value, Bool &error) const
 Implementation of IAttributes::GetValueByName(const Char* name, const IAttributes* params, UInt32& value, Bool& error) const.
 
virtual Bool GetValueByName (const Char *name, const IAttributes *params, SInt32 &value, Bool &error) const
 Implementation of IAttributes::GetValueByName(const Char* name, const IAttributes* params, SInt32& value, Bool& error) const.
 
virtual Bool GetValueByName (const Char *name, const IAttributes *params, Double &value, Bool &error) const
 Implementation of IAttributes::GetValueByName(const Char* name, const IAttributes* params, Double& value, Bool& error) const.
 
virtual Bool GetValueByName (const Char *name, const IAttributes *params, Float &value, Bool &error) const
 Implementation of IAttributes::GetValueByName(const Char* name, const IAttributes* params, Float& value, Bool& error) const.
 
virtual Bool GetValueByName (const Char *name, const IAttributes *params, Color &value, Bool &error) const
 Implementation of IAttributes::GetValueByName(const Char* name, const IAttributes* params, Color& value, Bool& error) const.
 
virtual Bool GetAngleValueByName (const Char *name, const IAttributes *params, Double &value, Bool &error) const
 Implementation of IAttributes::GetAngleValueByName(const Char* name, const IAttributes* params, Double& value, Bool& error) const.
 
virtual Bool GetAngleValueByName (const Char *name, const IAttributes *params, Float &value, Bool &error) const
 Implementation of IAttributes::GetAngleValueByName(const Char* name, const IAttributes* params, Float& value, Bool& error) const.
 
virtual Bool GetColorValueByName (const Char *name, const IAttributes *params, Float &value, Bool &error) const
 Implementation of IAttributes::GetColorValueByName(const Char* name, const IAttributes* params, Float& value, Bool& error) const.
 
virtual Bool GetValuesByName (const Char *name, const IAttributes *params, StringArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByName(const Char* name, const IAttributes* params, StringArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByName (const Char *name, const IAttributes *params, BoolArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByName(const Char* name, const IAttributes* params, BoolArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByName (const Char *name, const IAttributes *params, UInt32Array &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByName(const Char* name, const IAttributes* params, UInt32Array& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByName (const Char *name, const IAttributes *params, SInt32Array &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByName(const Char* name, const IAttributes* params, SInt32Array& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByName (const Char *name, const IAttributes *params, DoubleArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByName(const Char* name, const IAttributes* params, DoubleArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetValuesByName (const Char *name, const IAttributes *params, FloatArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetValuesByName(const Char* name, const IAttributes* params, FloatArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetAngleValuesByName (const Char *name, const IAttributes *params, DoubleArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetAngleValuesByName(const Char* name, const IAttributes* params, DoubleArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetAngleValuesByName (const Char *name, const IAttributes *params, FloatArray &values, Bool &error, Bool clear=true) const
 Implementation of IAttributes::GetAngleValuesByName(const Char* name, const IAttributes* params, FloatArray& values, Bool& error, Bool clear) const.
 
virtual Bool GetBitsToSetByName (const Char *name, const IAttributes *params, UInt32 &value, Bool &error) const
 Implementation of IAttributes::GetBitsToSetByName(const Char* name, const IAttributes* params, UInt32& value, Bool& error) const.
 
- Public Member Functions inherited from Murl::Util::AttributesBase
 AttributesBase ()
 The default constructor.
 
virtual ~AttributesBase ()
 The destructor.
 
Bool EvaluateParameters (const IAttributes *params, String &value, Bool &error) const
 Evaluate the attribute values inside curly braces. More...
 
virtual Bool EvaluateExpression (const Char *expression, String &value, Bool &error) const
 Implementation of IAttributes::EvaluateExpression(const String& expression, String& result) const.
 
- Public Member Functions inherited from Murl::IAttributes
virtual ~IAttributes ()
 The destructor.
 
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...
 
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 attributes class, see IAttributes.

Constructor & Destructor Documentation

◆ Attributes() [1/3]

Murl::Util::Attributes::Attributes ( const Char **  attributes)

Constructor taking a string array.

The first array element contains the attribute name and the second array element contains the corresponding attribute value. The array must be terminated by a null pointer in the last element.

Parameters
attributesThe string array containing name and value pairs.

◆ Attributes() [2/3]

Murl::Util::Attributes::Attributes ( const IAttributes other,
Bool  unusedOnly = false 
)

Constructor copying attributes with option.

Parameters
otherThe attributes to copy.
unusedOnlyCopy unused attributes only if true.

◆ Attributes() [3/3]

Murl::Util::Attributes::Attributes ( const IAttributes base,
const IAttributes additional 
)

Constructor copying attributes.

Parameters
baseThe attributes to copy.
additionalThe additional attributes to copy.

The documentation for this class was generated from the following file:
  • murl_util_attributes.h


Copyright © 2011-2018 Spraylight GmbH.