Murl::Util::AttributesBase Class Reference

The attributes base class, see IAttributes. More...

#include "murl_util_attributes_base.h"

Inheritance diagram for Murl::Util::AttributesBase:

Public Member Functions

 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.
 
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::IAttributes
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 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...
 
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 base class, see IAttributes.

Member Function Documentation

◆ EvaluateParameters()

Bool Murl::Util::AttributesBase::EvaluateParameters ( const IAttributes params,
String value,
Bool error 
) const

Evaluate the attribute values inside curly braces.

Parameters
paramsThe attributes for value substituion inside braces or null.
valueThe substituted string return value.
errorThe error return value is set to true if value substituion failed.
Returns
true if successful, false if the attribute has no value or if error is true.

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


Copyright © 2011-2018 Spraylight GmbH.