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... | |
| ~Attributes () override | |
| The destructor. | |
 Public Member Functions inherited from Murl::Util::AttributesBase | |
| AttributesBase () | |
| The default constructor. | |
| ~AttributesBase () override | |
| The destructor. | |
| Bool | EvaluateParameters (const IAttributes *params, String &value, Bool &error) const |
| Evaluate the attribute values inside curly braces. More... | |
| Bool | EvaluateParameters (const IAttributes *params, String &value, Result &result) const |
| Evaluate the attribute values inside curly braces. More... | |
| Public Member Functions inherited from Murl::IAttributes | |
| virtual | ~IAttributes ()=default |
| 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 | 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... | |
| 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 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
-
attributes The 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
-
other The attributes to copy. unusedOnly Copy unused attributes only if true.
◆ Attributes() [3/3]
| Murl::Util::Attributes::Attributes | ( | const IAttributes * | base, |
| const IAttributes * | additional | ||
| ) |
Constructor copying attributes.
- Parameters
-
base The attributes to copy. additional The additional attributes to copy.
The documentation for this class was generated from the following file:
- murl_util_attributes.h