PropertyDefinition defines a property that will be available within the PropertyUser. More...

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

Inheritance diagram for PropertyDefinition< PropertyType >:

Public Types
typedef std::function< PropertyType(std::string)>	PropertyFactoryFunction

using	PropertyTypePtr = std::shared_ptr<PropertyType>

using	PropertyValuesMap = std::map<std::string, ValueEntry>

using	ValueEntry = std::pair<std::string, PropertyType>

Public Types inherited from PropertyDefinitionBase
enum	PropertyConstness { eConstant , eModifiable }

Public Member Functions
bool	expandEnvironmentVariables () const

std::string	getDefaultAsString () override

PropertyType	getDefaultValue ()

std::string	getDescription () const

PropertyFactoryFunction	getFactory () const

std::string	getMatchRegex () const

double	getMax () const

double	getMin () const

std::string	getPropertyName () const

PropertyType	getValue (const std::string &prefix, Ice::PropertiesPtr)

PropertyValuesMap &	getValueMap ()

bool	isCaseInsensitive () const

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

PropertyDefinition< PropertyType > &	map (const std::map< std::string, PropertyType > &values)

template<class T>
std::enable_if_t< std::is_same_v< T, PropertyType > &&!std::is_same_v< T, std::string >, PropertyDefinition< T > & >	map (const std::map< T, std::string > &values)

PropertyDefinition< PropertyType > &	map (const std::string &valueString, PropertyType value)
	Maps a string value onto a value of the specified template type.

template<class T>
std::enable_if_t< meta::properties::MapPropertyValuePlugin< T >::value, PropertyDefinition< PropertyType > & >	map (const T &values)

	PropertyDefinition (PropertyType *setterRef, const std::string &propertyName, const std::string &description, PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant)
	Constructs a property definition of a required property.

	PropertyDefinition (PropertyType *setterRef, const std::string &propertyName, PropertyType defaultValue, const std::string &description, PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant)
	Constructs a property definition of an optional property.

	PropertyDefinition (std::function< void(const PropertyType &)> setter, const std::string &propertyName, PropertyType defaultValue, const std::string &description, PropertyDefinitionBase::PropertyConstness constness=PropertyDefinitionBase::eConstant)

bool	removeQuotes () const

PropertyDefinition< PropertyType > &	setCaseInsensitive (bool isCaseInsensitive)
	Sets whether the property value matching is case insensitive.

PropertyDefinition< PropertyType > &	setExpandEnvironmentVariables (bool expand)
	Sets whether for string values environment varbiale expanding should be considered.

PropertyDefinition< PropertyType > &	setFactory (const PropertyFactoryFunction &func)
	Sets the factory function that creates the specified template type from the actual string value.

PropertyDefinition< PropertyType > &	setMatchRegex (const std::string &expr)
	Sets the regular expression which the value has to be matched with.

PropertyDefinition< PropertyType > &	setMax (double max)
	Sets the max allowed numeric value.

template<class T = PropertyType>
PropertyDefinition< PropertyType > &	setMax (std::array< T, 1 > max)

PropertyDefinition< PropertyType > &	setMin (double min)
	Sets the min allowed numeric value.

template<class T = PropertyType>
PropertyDefinition< PropertyType > &	setMin (std::array< T, 1 > min)

PropertyDefinition< PropertyType > &	setRemoveQuotes (bool removeQuotes)
	Sets whether for string values leading and trailing quotes should be removed.

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

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

Public Member Functions inherited from PropertyDefinitionBase
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	~PropertyDefinitionBase ()

Static Public Member Functions
static void	removeQuotes (const std::string &input, std::string &output)
	Checks first and last character of input and in case both are quotes, they are removed and the remaining result is stored in output.

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

Protected Attributes
bool	caseInsensitive
	Case sensitivity indicator.

PropertyType	defaultValue
	Fallback/Default property value.

std::string	description
	Property description.

bool	expandEnvVars
	Exand environments variables indicator (standard: true)

PropertyFactoryFunction	factory
	Builder function.

double	max
	Upper bound of numeric values (used for numeric value retrieval without mapping)

double	min
	Lower bound of numeric values (used for numeric value retrieval without mapping)

std::string	propertyName
	Property name.

PropertyValuesMap	propertyValuesMap
	Main property map.

std::string	regex
	Regular expression to approve a required value pattern.

std::optional< std::function< void(const PropertyType &)> >	setter

PropertyType *	setterRef
	Reference to a variable to set.

bool	stringRemoveQuotes
	Remove leading and trailing quotes indicator (standard: true) First and last character of a string property value are checked for quotes.

Protected Attributes inherited from PropertyDefinitionBase
PropertyConstness	constness

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

Detailed Description

template<typename PropertyType>
class armarx::PropertyDefinition< PropertyType >

PropertyDefinition defines a property that will be available within the PropertyUser.

PropertyDefinition provides the definition and description of a property that may be definined in a config file or passed via command line as an option. Depending which constructor is used a property is either required or optional. In the latter case a default value has to be specified.

The property specific value type (PropertyType) can be arbitrary, yet it is devided into these three groups which are handled internally differently:

String values
Arithmetic values (integral & floating point types)
Custom objects (Classes, Structs, Enums)

Fluent Interface

All setters are self referential and therefor can be chained to simplify the implementation and increase the readability.

Example

PropertyDefinition<float> frameRateDef("MyFrameRate", "Capture frame rate");
 
frameRateDef
    .setMatchRegex("\\d+(.\\d*)?")
    .setMin(0.0f)
    .setMax(60.0f);

Member Typedef Documentation

◆ PropertyFactoryFunction

template<typename PropertyType>

typedef std::function<PropertyType(std::string)> PropertyFactoryFunction

◆ PropertyTypePtr

template<typename PropertyType>

using PropertyTypePtr = std::shared_ptr<PropertyType>

◆ PropertyValuesMap

template<typename PropertyType>

using PropertyValuesMap = std::map<std::string, ValueEntry>

◆ ValueEntry

template<typename PropertyType>

using ValueEntry = std::pair<std::string, PropertyType>

Constructor & Destructor Documentation

◆ PropertyDefinition() [1/3]

template<typename PropertyType>

PropertyDefinition	(	PropertyType *	setterRef,
		const std::string &	propertyName,
		const std::string &	description,
		PropertyDefinitionBase::PropertyConstness	constness = PropertyDefinitionBase::eConstant )

Constructs a property definition of a required property.

Parameters

setterRef	Setter
propertyName	Name of the property used in config files
description	Mandatory property description

◆ PropertyDefinition() [2/3]

template<typename PropertyType>

PropertyDefinition	(	PropertyType *	setterRef,
		const std::string &	propertyName,
		PropertyType	defaultValue,
		const std::string &	description,
		PropertyDefinitionBase::PropertyConstness	constness = PropertyDefinitionBase::eConstant )

inline

Constructs a property definition of an optional property.

Parameters

setterRef	Setter
propertyName	Name of the property used in config files
defaultValue	Property default value of the type PropertyType
description	Mandatory property description

◆ PropertyDefinition() [3/3]

template<typename PropertyType>

PropertyDefinition	(	std::function< void(const PropertyType &)>	setter,
		const std::string &	propertyName,
		PropertyType	defaultValue,
		const std::string &	description,
		PropertyDefinitionBase::PropertyConstness	constness = PropertyDefinitionBase::eConstant )

inline

Member Function Documentation

◆ expandEnvironmentVariables()

template<typename PropertyType>

bool expandEnvironmentVariables ( ) const

◆ getDefaultAsString()

template<typename PropertyType>

std::string getDefaultAsString ( )

overridevirtual

Implements PropertyDefinitionBase.

◆ getDefaultValue()

template<typename PropertyType>

PropertyType getDefaultValue ( )

◆ getDescription()

template<typename PropertyType>

std::string getDescription ( ) const

◆ getFactory()

template<typename PropertyType>

PropertyDefinition< PropertyType >::PropertyFactoryFunction getFactory ( ) const

◆ getMatchRegex()

template<typename PropertyType>

std::string getMatchRegex ( ) const

◆ getMax()

template<typename PropertyType>

double getMax ( ) const

◆ getMin()

template<typename PropertyType>

double getMin ( ) const

◆ getPropertyName()

template<typename PropertyType>

std::string getPropertyName ( ) const

◆ getValue()

template<typename PropertyType>

PropertyType getValue	(	const std::string &	prefix,
		Ice::PropertiesPtr	iceProperties )

◆ getValueMap()

template<typename PropertyType>

PropertyDefinition< PropertyType >::PropertyValuesMap & getValueMap ( )

◆ isCaseInsensitive()

template<typename PropertyType>

bool isCaseInsensitive ( ) const

◆ isSet()

template<typename PropertyType>

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

◆ map() [1/4]

template<typename PropertyType>

PropertyDefinition< PropertyType > & map ( const std::map< std::string, PropertyType > & values )

inline

◆ map() [2/4]

template<typename PropertyType>

template<class T>

std::enable_if_t< std::is_same_v< T, PropertyType > &&!std::is_same_v< T, std::string >, PropertyDefinition< T > & > map ( const std::map< T, std::string > & values )

inline

◆ map() [3/4]

template<typename PropertyType>

PropertyDefinition< PropertyType > & map	(	const std::string &	valueString,
		PropertyType	value )

inline

Maps a string value onto a value of the specified template type.

Parameters

valueString	Property string value key
value	Property value

Returns: self reference

◆ map() [4/4]

template<typename PropertyType>

template<class T>

std::enable_if_t< meta::properties::MapPropertyValuePlugin< T >::value, PropertyDefinition< PropertyType > & > map ( const T & values )

inline

◆ removeQuotes() [1/2]

template<typename PropertyType>

bool removeQuotes ( ) const

◆ removeQuotes() [2/2]

template<typename PropertyType>

void removeQuotes	(	const std::string &	input,
		std::string &	output )

static

Checks first and last character of input and in case both are quotes, they are removed and the remaining result is stored in output.

◆ setCaseInsensitive()

template<typename PropertyType>

PropertyDefinition< PropertyType > & setCaseInsensitive ( bool isCaseInsensitive )

Sets whether the property value matching is case insensitive.

Parameters

isCaseInsensitive Case sensitivity state

Returns: self reference

◆ setExpandEnvironmentVariables()

template<typename PropertyType>

PropertyDefinition< PropertyType > & setExpandEnvironmentVariables ( bool expand )

Sets whether for string values environment varbiale expanding should be considered.

Parameters

expand Expand entries like '${ENV_VAR}' to the according values of the environment.

Returns: self reference

◆ setFactory()

template<typename PropertyType>

PropertyDefinition< PropertyType > & setFactory ( const PropertyFactoryFunction & func )

Sets the factory function that creates the specified template type from the actual string value.

Parameters

func	the factory function

Returns: self reference

◆ setMatchRegex()

template<typename PropertyType>

PropertyDefinition< PropertyType > & setMatchRegex ( const std::string & expr )

Sets the regular expression which the value has to be matched with.

Parameters

expr	Value regular expression

Returns: self reference

◆ setMax() [1/2]

template<typename PropertyType>

PropertyDefinition< PropertyType > & setMax ( double max )

Sets the max allowed numeric value.

Parameters

max	Max. allowed value

Returns: self reference

◆ setMax() [2/2]

template<typename PropertyType>

template<class T = PropertyType>

PropertyDefinition< PropertyType > & setMax ( std::array< T, 1 > max )

inline

◆ setMin() [1/2]

template<typename PropertyType>

PropertyDefinition< PropertyType > & setMin ( double min )

Sets the min allowed numeric value.

Parameters

min	Min. allowed value

Returns: self reference

◆ setMin() [2/2]

template<typename PropertyType>

template<class T = PropertyType>

PropertyDefinition< PropertyType > & setMin ( std::array< T, 1 > min )

inline

◆ setRemoveQuotes()

template<typename PropertyType>

PropertyDefinition< PropertyType > & setRemoveQuotes ( bool removeQuotes )

Sets whether for string values leading and trailing quotes should be removed.

Parameters

removeQuotes The indicator.

Returns: self reference

◆ toString()

template<typename PropertyType>

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

overridevirtual

See also: PropertyDefinitionBase::toString()

Implements PropertyDefinitionBase.

◆ writeValueToSetter()

template<typename PropertyType>

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

overridevirtual

Implements PropertyDefinitionBase.

Member Data Documentation

◆ caseInsensitive

template<typename PropertyType>

bool caseInsensitive

protected

Case sensitivity indicator.

◆ defaultValue

template<typename PropertyType>

PropertyType defaultValue

protected

Fallback/Default property value.

◆ description

template<typename PropertyType>

std::string description

protected

Property description.

◆ expandEnvVars

template<typename PropertyType>

bool expandEnvVars

protected

Exand environments variables indicator (standard: true)

◆ factory

template<typename PropertyType>

PropertyFactoryFunction factory

protected

Builder function.

◆ max

template<typename PropertyType>

double max

protected

Upper bound of numeric values (used for numeric value retrieval without mapping)

◆ min

template<typename PropertyType>

double min

protected

Lower bound of numeric values (used for numeric value retrieval without mapping)

◆ propertyName

template<typename PropertyType>

std::string propertyName

protected

Property name.

◆ propertyValuesMap

template<typename PropertyType>

PropertyValuesMap propertyValuesMap

protected

Main property map.

◆ regex

template<typename PropertyType>

std::string regex

protected

Regular expression to approve a required value pattern.

◆ setter

template<typename PropertyType>

std::optional<std::function<void(const PropertyType&)> > setter

protected

◆ setterRef

template<typename PropertyType>

PropertyType* setterRef

protected

Reference to a variable to set.

◆ stringRemoveQuotes

template<typename PropertyType>

bool stringRemoveQuotes

protected

Remove leading and trailing quotes indicator (standard: true) First and last character of a string property value are checked for quotes.

E.g. "test" -> test 'test' -> test

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

ArmarXCore/core/application/properties/PropertyDefinition.h
ArmarXCore/core/application/properties/PropertyDefinition.hpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Fluent Interface

Example

Member Typedef Documentation

◆ PropertyFactoryFunction

◆ PropertyTypePtr

◆ PropertyValuesMap

◆ ValueEntry

Constructor & Destructor Documentation

◆ PropertyDefinition() [1/3]

◆ PropertyDefinition() [2/3]

◆ PropertyDefinition() [3/3]

Member Function Documentation

◆ expandEnvironmentVariables()

◆ getDefaultAsString()

◆ getDefaultValue()

◆ getDescription()

◆ getFactory()

◆ getMatchRegex()

◆ getMax()

◆ getMin()

◆ getPropertyName()

◆ getValue()

◆ getValueMap()

◆ isCaseInsensitive()

◆ isSet()

◆ map() [1/4]

◆ map() [2/4]

◆ map() [3/4]

◆ map() [4/4]

◆ removeQuotes() [1/2]

◆ removeQuotes() [2/2]

◆ setCaseInsensitive()

◆ setExpandEnvironmentVariables()

◆ setFactory()

◆ setMatchRegex()

◆ setMax() [1/2]

◆ setMax() [2/2]

◆ setMin() [1/2]

◆ setMin() [2/2]

◆ setRemoveQuotes()

◆ toString()

◆ writeValueToSetter()

Member Data Documentation

◆ caseInsensitive

◆ defaultValue

◆ description

◆ expandEnvVars

◆ factory

◆ max

◆ min

◆ propertyName

◆ propertyValuesMap

◆ regex

◆ setter

◆ setterRef

◆ stringRemoveQuotes