PropertyDefinitionBase Class Reference

Common interface of any property definition. More...

#include <ArmarXCore/core/application/properties/PropertyDefinitionInterface.h>

Inheritance diagram for PropertyDefinitionBase:

Public Types
enum	PropertyConstness { eConstant , eModifiable }

Public Member Functions
virtual std::string	getDefaultAsString ()=0
bool	isConstant () const
bool	isRequired () const
bool	isSet (std::string const &prefix, std::string const &propertyName, Ice::PropertiesPtr const &iceProperties) const
	PropertyDefinitionBase (bool required=true, PropertyConstness constness=eConstant)
virtual std::string	toString (PropertyDefinitionFormatter &formatter, const std::string &value)=0
	Converts the property definition into a string using a specified formatter.
virtual void	writeValueToSetter (const std::string &prefix, Ice::PropertiesPtr)=0
virtual	~PropertyDefinitionBase ()

Static Public Member Functions
static std::string	icePropertyGet (Ice::PropertiesPtr const &iceProperties, std::string const &key)

Protected Attributes
PropertyConstness	constness
bool	required
	If set to true, the property must be explicitely set through configuration parameters.

Friends
class	PropertyDefinitionContainer

Detailed Description

Common interface of any property definition.

This abstract class is part of the internal implementation

Member Enumeration Documentation

PropertyConstness

enum PropertyConstness

Enumerator
eConstant
eModifiable

Constructor & Destructor Documentation

PropertyDefinitionBase()

PropertyDefinitionBase ( bool required = true, PropertyConstness constness = eConstant )

inline

~PropertyDefinitionBase()

virtual ~PropertyDefinitionBase ( )

inlinevirtual

Member Function Documentation

getDefaultAsString()

virtual std::string getDefaultAsString ( )

pure virtual

Implemented in PropertyDefinition< PropertyType >, PropertyValuesMap< PropertyType >, and PropertyValuesMap< PropertyType >.

icePropertyGet()

std::string icePropertyGet ( Ice::PropertiesPtr const & iceProperties, std::string const & key )

static

isConstant()

bool isConstant ( ) const

inline

isRequired()

bool isRequired ( ) const

inline

isSet()

bool isSet	(	std::string const &	prefix,
		std::string const &	propertyName,
		Ice::PropertiesPtr const &	iceProperties ) const

toString()

virtual std::string toString ( PropertyDefinitionFormatter & formatter, const std::string & value )

pure virtual

Converts the property definition into a string using a specified formatter.

Parameters

formatter

Custom definition formatter

Implemented in PropertyDefinition< PropertyType >, PropertyValuesMap< PropertyType >, and PropertyValuesMap< PropertyType >.

writeValueToSetter()

virtual void writeValueToSetter ( const std::string & prefix, Ice::PropertiesPtr  )

pure virtual

Implemented in PropertyDefinition< PropertyType >, PropertyValuesMap< PropertyType >, and PropertyValuesMap< PropertyType >.

Friends And Related Symbol Documentation

PropertyDefinitionContainer

friend class PropertyDefinitionContainer

friend

Member Data Documentation

constness

PropertyConstness constness

protected

required

bool required

protected

If set to true, the property must be explicitely set through configuration parameters.

---

The documentation for this class was generated from the following files:

• ArmarXCore/core/application/properties/PropertyDefinitionInterface.h
• ArmarXCore/core/application/properties/PropertyDefinition.cpp