A parameter class. More...

#include <sdf/sdf.hh>

Public Member Functions
	Param (const Param &_param)
	Copy constructor Note that the updateFunc member does not get copied. More...

	Param (const std::string &_key, const std::string &_typeName, const std::string &_default, bool _required, const std::string &_description="")
	Constructor. More...

	Param (const std::string &_key, const std::string &_typeName, const std::string &_default, bool _required, const std::string &_minValue, const std::string &_maxValue, const std::string &_description="")
	Constructor with min and max values. More...

	Param (Param &&_param) noexcept=default
	Move constructor. More...

virtual	~Param ()
	Destructor. More...

ParamPtr	Clone () const
	Clone the parameter. More...

template<typename T >
bool	Get (T &_value) const
	Get the value of the parameter. More...

bool	GetAny (std::any &_anyVal) const
	Get the value of the parameter as a std::any. More...

std::string	GetAsString (const PrintConfig &_config=PrintConfig()) const
	Get the value as a string. More...

template<typename T >
bool	GetDefault (T &_value) const
	Get the default value of the parameter. More...

std::string	GetDefaultAsString (const PrintConfig &_config=PrintConfig()) const
	Get the default value as a string. More...

std::string	GetDescription () const
	Get the description of the parameter. More...

const std::string &	GetKey () const
	Get the key value. More...

std::optional< std::string >	GetMaxValueAsString (const PrintConfig &_config=PrintConfig()) const
	Get the maximum allowed value as a string. More...

std::optional< std::string >	GetMinValueAsString (const PrintConfig &_config=PrintConfig()) const
	Get the minimum allowed value as a string. More...

ElementPtr	GetParentElement () const
	Get the parent Element of this Param. More...

bool	GetRequired () const
	Return whether the parameter is required. More...

bool	GetSet () const
	Return true if the parameter has been set. More...

const std::string &	GetTypeName () const
	Get the type name value. More...

bool	IgnoresParentElementAttribute () const
	Return true if the parameter ignores the parent element's attributes, or if the parameter has no parent element. More...

template<typename Type >
bool	IsType () const
	Return true if the param is a particular type. More...

Param &	operator= (const Param &_param)
	Copy assignment operator Note that the updateFunc member will not get copied. More...

Param &	operator= (Param &&_param) noexcept=default
	Move assignment operator. More...

bool	Reparse ()
	Reparse the parameter value. More...

void	Reset ()
	Reset the parameter to the default value. More...

template<typename T >
bool	Set (const T &_value)
	Set the parameter's value. More...

void	SetDescription (const std::string &_desc)
	Set the description of the parameter. More...

bool	SetFromString (const std::string &_value)
	Set the parameter value from a string. More...

bool	SetFromString (const std::string &_value, bool _ignoreParentAttributes)
	Set the parameter value from a string. More...

bool	SetParentElement (ElementPtr _parentElement)
	Set the parent Element of this Param. More...

template<typename T >
void	SetUpdateFunc (T _updateFunc)
	Set the update function. More...

void	Update ()
	Set the parameter's value using the updateFunc. More...

bool	ValidateValue () const
	Validate the value against minimum and maximum allowed values. More...

Detailed Description

A parameter class.

Constructor & Destructor Documentation

◆ Param() [1/4]

sdf::SDF_VERSION_NAMESPACE::Param::Param	(	const std::string &	_key,
		const std::string &	_typeName,
		const std::string &	_default,
		bool	_required,
		const std::string &	_description = `""`
	)

Constructor.

Parameters

[in]	_key	Key for the parameter.
[in]	_typeName	String name for the value type (double, int,...).
[in]	_default	Default value.
[in]	_required	True if the parameter is required to be set.
[in]	_description	Description of the parameter.

Exceptions

sdf::AssertionInternalError if an invalid type is given.

◆ Param() [2/4]

sdf::SDF_VERSION_NAMESPACE::Param::Param	(	const std::string &	_key,
		const std::string &	_typeName,
		const std::string &	_default,
		bool	_required,
		const std::string &	_minValue,
		const std::string &	_maxValue,
		const std::string &	_description = `""`
	)

Constructor with min and max values.

Parameters

[in]	_key	Key for the parameter.
[in]	_typeName	String name for the value type (double, int,...).
[in]	_default	Default value.
[in]	_required	True if the parameter is required to be set.
[in]	_minValue	Minimum allowed value for the parameter.
[in]	_maxValue	Maximum allowed value for the parameter.
[in]	_description	Description of the parameter.

Exceptions

sdf::AssertionInternalError if an invalid type is given.

◆ Param() [3/4]

sdf::SDF_VERSION_NAMESPACE::Param::Param ( const Param & _param )

Copy constructor Note that the updateFunc member does not get copied.

Parameters

[in] _param Param to copy

◆ Param() [4/4]

sdf::SDF_VERSION_NAMESPACE::Param::Param ( Param && _param )

defaultnoexcept

Move constructor.

Parameters

[in] _param Param to move from

◆ ~Param()

virtual sdf::SDF_VERSION_NAMESPACE::Param::~Param ( )

virtual

Destructor.

Member Function Documentation

◆ Clone()

ParamPtr sdf::SDF_VERSION_NAMESPACE::Param::Clone ( ) const

Clone the parameter.

Returns: A new parameter that is the clone of this.

◆ Get()

template<typename T >

bool sdf::SDF_VERSION_NAMESPACE::Param::Get ( T & _value ) const

Get the value of the parameter.

Parameters

[out] _value The value of the parameter.

Returns: True if parameter was successfully cast to the value type passed in.

References GetAsString(), sdf::SDF_VERSION_NAMESPACE::lowercase(), and sdferr.

◆ GetAny()

bool sdf::SDF_VERSION_NAMESPACE::Param::GetAny ( std::any & _anyVal ) const

Get the value of the parameter as a std::any.

Parameters

[out] _anyVal The std::any object to set.

Returns: True if successfully fetched _anyVal, false otherwise.

◆ GetAsString()

std::string sdf::SDF_VERSION_NAMESPACE::Param::GetAsString ( const PrintConfig & _config = PrintConfig() ) const

Get the value as a string.

Parameters

[in] _config Configuration for conversion to string.

Returns: String containing the value of the parameter.

Referenced by Get().

◆ GetDefault()

template<typename T >

bool sdf::SDF_VERSION_NAMESPACE::Param::GetDefault ( T & _value ) const

Get the default value of the parameter.

Parameters

[out] _value The default value of the parameter.

Returns: True if parameter was successfully cast to the value type passed in.

References sdferr.

◆ GetDefaultAsString()

std::string sdf::SDF_VERSION_NAMESPACE::Param::GetDefaultAsString ( const PrintConfig & _config = PrintConfig() ) const

Get the default value as a string.

Parameters

[in] _config Configuration for conversion to string.

Returns: String containing the default value of the parameter.

◆ GetDescription()

std::string sdf::SDF_VERSION_NAMESPACE::Param::GetDescription ( ) const

Get the description of the parameter.

Returns: The description of the parameter.

◆ GetKey()

const std::string& sdf::SDF_VERSION_NAMESPACE::Param::GetKey ( ) const

Get the key value.

Returns: The key.

◆ GetMaxValueAsString()

std::optional<std::string> sdf::SDF_VERSION_NAMESPACE::Param::GetMaxValueAsString ( const PrintConfig & _config = PrintConfig() ) const

Get the maximum allowed value as a string.

Parameters

[in] _config Configuration for conversion to string.

Returns: Returns a string containing the maximum allowed value of the parameter if the maximum value is specified in the SDFormat description of the parameter. nullopt otherwise.

◆ GetMinValueAsString()

std::optional<std::string> sdf::SDF_VERSION_NAMESPACE::Param::GetMinValueAsString ( const PrintConfig & _config = PrintConfig() ) const

Get the minimum allowed value as a string.

Parameters

[in] _config Configuration for conversion to string.

Returns: Returns a string containing the minimum allowed value of the parameter if the minimum value is specified in the SDFormat description of the parameter. nullopt otherwise.

◆ GetParentElement()

ElementPtr sdf::SDF_VERSION_NAMESPACE::Param::GetParentElement ( ) const

Get the parent Element of this Param.

Returns: Pointer to this Param's parent Element, nullptr if there is no parent Element.

◆ GetRequired()

bool sdf::SDF_VERSION_NAMESPACE::Param::GetRequired ( ) const

Return whether the parameter is required.

Returns: True if the parameter is required.

◆ GetSet()

bool sdf::SDF_VERSION_NAMESPACE::Param::GetSet ( ) const

Return true if the parameter has been set.

Returns: True if the parameter has been set.

◆ GetTypeName()

const std::string& sdf::SDF_VERSION_NAMESPACE::Param::GetTypeName ( ) const

Get the type name value.

Returns: The type name.

◆ IgnoresParentElementAttribute()

bool sdf::SDF_VERSION_NAMESPACE::Param::IgnoresParentElementAttribute ( ) const

Return true if the parameter ignores the parent element's attributes, or if the parameter has no parent element.

Returns: True if the parameter ignores the parent element's attributes, or if the parameter has no parent element.

◆ IsType()

template<typename Type >

bool sdf::SDF_VERSION_NAMESPACE::Param::IsType

Return true if the param is a particular type.

Returns: True if the type held by this Param matches the Type template parameter.

◆ operator=() [1/2]

Param& sdf::SDF_VERSION_NAMESPACE::Param::operator= ( const Param & _param )

Copy assignment operator Note that the updateFunc member will not get copied.

Parameters

[in] _param The parameter to set values from.

Returns: *This

◆ operator=() [2/2]

Param& sdf::SDF_VERSION_NAMESPACE::Param::operator= ( Param && _param )

defaultnoexcept

Move assignment operator.

Parameters

[in] _param Param to move from

Returns: Reference to this

◆ Reparse()

bool sdf::SDF_VERSION_NAMESPACE::Param::Reparse ( )

Reparse the parameter value.

This should be called after the parent element's attributes have been modified, in the event that the value was set using SetFromString or posesses a default value, and that the final parsed value is dependent on the attributes of the parent element. For example, the rotation component of a pose element can be parsed as degrees or radians, depending on the attribute @degrees of the parent element. If however the value was explicitly set using the Set<T> function, reparsing would not change the value.

Returns: True if the parameter value has been reparsed successfully.

See also: bool SetFromString(const std::string &_value); bool Set(const T &_value)

◆ Reset()

void sdf::SDF_VERSION_NAMESPACE::Param::Reset ( )

Reset the parameter to the default value.

◆ Set()

template<typename T >

bool sdf::SDF_VERSION_NAMESPACE::Param::Set ( const T & _value )

Set the parameter's value.

The passed in value value must have an input and output stream operator.

Parameters

[in] _value The value to set the parameter to.

Returns: True if the value was successfully set.

References sdferr, and SetFromString().

◆ SetDescription()

void sdf::SDF_VERSION_NAMESPACE::Param::SetDescription ( const std::string & _desc )

Set the description of the parameter.

Parameters

[in] _desc New description for the parameter.

◆ SetFromString() [1/2]

bool sdf::SDF_VERSION_NAMESPACE::Param::SetFromString ( const std::string & _value )

Set the parameter value from a string.

Parameters

[in] _value New value for the parameter in string form.

◆ SetFromString() [2/2]

bool sdf::SDF_VERSION_NAMESPACE::Param::SetFromString	(	const std::string &	_value,
		bool	_ignoreParentAttributes
	)

Set the parameter value from a string.

Parameters

[in]	_value	New value for the parameter in string form.
[in]	_ignoreParentAttributes	Whether to ignore parent element attributes when parsing value from string as well as subsequent reparses.

Referenced by Set().

◆ SetParentElement()

bool sdf::SDF_VERSION_NAMESPACE::Param::SetParentElement ( ElementPtr _parentElement )

Set the parent Element of this Param.

Parameters

[in] _parentElement Pointer to new parent Element. A nullptr can provided to remove the current parent Element.

Returns: True if the parent Element was set and the value was reparsed successfully.

◆ SetUpdateFunc()

template<typename T >

void sdf::SDF_VERSION_NAMESPACE::Param::SetUpdateFunc ( T _updateFunc )

Set the update function.

The updateFunc will be used to set the parameter's value when Param::Update is called.

Parameters

[in] _updateFunc Function pointer to an update function.

◆ Update()

void sdf::SDF_VERSION_NAMESPACE::Param::Update ( )

Set the parameter's value using the updateFunc.

See also: Param::SetUpdateFunc

◆ ValidateValue()

bool sdf::SDF_VERSION_NAMESPACE::Param::ValidateValue ( ) const

Validate the value against minimum and maximum allowed values.

Returns: True if the value is valid

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

Param.hh

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ Param() [1/4]

◆ Param() [2/4]

◆ Param() [3/4]

◆ Param() [4/4]

◆ ~Param()

Member Function Documentation

◆ Clone()

◆ Get()

◆ GetAny()

◆ GetAsString()

◆ GetDefault()

◆ GetDefaultAsString()

◆ GetDescription()

◆ GetKey()

◆ GetMaxValueAsString()

◆ GetMinValueAsString()

◆ GetParentElement()

◆ GetRequired()

◆ GetSet()

◆ GetTypeName()

◆ IgnoresParentElementAttribute()

◆ IsType()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ Reparse()

◆ Reset()

◆ Set()

◆ SetDescription()

◆ SetFromString() [1/2]

◆ SetFromString() [2/2]

◆ SetParentElement()

◆ SetUpdateFunc()

◆ Update()

◆ ValidateValue()