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. More...
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. More...

Friends
class	PropertyDefinitionContainer

Detailed Description

Common interface of any property definition.

This abstract class is part of the internal implementation

Definition at line 51 of file PropertyDefinitionInterface.h.

Member Enumeration Documentation

PropertyConstness

enum PropertyConstness

Enumerator
eConstant
eModifiable

Definition at line 54 of file PropertyDefinitionInterface.h.

Constructor & Destructor Documentation

PropertyDefinitionBase()

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

inline

Definition at line 60 of file PropertyDefinitionInterface.h.

~PropertyDefinitionBase()

virtual ~PropertyDefinitionBase ( )

inlinevirtual

Definition at line 65 of file PropertyDefinitionInterface.h.

Member Function Documentation

getDefaultAsString()

virtual std::string getDefaultAsString ( )

pure virtual

Implemented in PropertyDefinition< PropertyType >.

Here is the caller graph for this function:

icePropertyGet()

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

static

Definition at line 267 of file PropertyDefinition.cpp.

isConstant()

bool isConstant ( ) const

inline

Definition at line 81 of file PropertyDefinitionInterface.h.

isRequired()

bool isRequired ( ) const

inline

Definition at line 75 of file PropertyDefinitionInterface.h.

isSet()

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

Definition at line 272 of file PropertyDefinition.cpp.

Here is the caller graph for this function:

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

writeValueToSetter()

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

pure virtual

Implemented in PropertyDefinition< PropertyType >.

Friends And Related Function Documentation

PropertyDefinitionContainer

friend class PropertyDefinitionContainer

friend

Definition at line 107 of file PropertyDefinitionInterface.h.

Member Data Documentation

constness

PropertyConstness constness

protected

Definition at line 104 of file PropertyDefinitionInterface.h.

required

bool required

protected

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

Definition at line 102 of file PropertyDefinitionInterface.h.

---

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

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