A parameter class. More...

#include <sdf/sdf.hh>

Public Member Functions
	Param (const std::string &_key, const std::string &_typeName, const std::string &_default, bool _required, const std::string &_description="")
	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 (boost::any &_anyVal) const
	Get the value of the parameter as a boost::any. More...

std::string	GetAsString () 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
	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...

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

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

const std::type_info &	GetType () const SDF_DEPRECATED(4.0)
	Get the type of the value stored. More...

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

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

Param &	operator= (const Param &_param)
	Equal operator. 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...

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

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

Friends
std::ostream &	operator<< (std::ostream &_out, const Param &_p)
	Ostream operator. More...

Detailed Description

A parameter class.

Constructor & Destructor Documentation

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

virtual sdf::Param::~Param ( )

virtual

Destructor.

Member Function Documentation

ParamPtr sdf::Param::Clone ( ) const

Clone the parameter.

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

template<typename T >

bool sdf::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 sdf::ParamPrivate::key, sdferr, sdf::ParamPrivate::typeName, and sdf::ParamPrivate::value.

bool sdf::Param::GetAny ( boost::any & _anyVal ) const

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

Parameters

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

Returns: True if successfully set _anyVal, false otherwise.

std::string sdf::Param::GetAsString ( ) const

Get the value as a string.

Returns: String containing the value of the parameter.

template<typename T >

bool sdf::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 sdf::ParamPrivate::defaultValue, sdf::ParamPrivate::key, sdferr, and sdf::ParamPrivate::typeName.

std::string sdf::Param::GetDefaultAsString ( ) const

Get the default value as a string.

Returns: String containing the default value of the parameter.

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

Get the description of the parameter.

Returns: The description of the parameter.

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

Get the key value.

Returns: The key.

bool sdf::Param::GetRequired ( ) const

Return whether the parameter is required.

Returns: True if the parameter is required.

bool sdf::Param::GetSet ( ) const

Return true if the parameter has been set.

Returns: True if the parameter has been set.

const std::type_info& sdf::Param::GetType ( ) const

Get the type of the value stored.

Returns: The std::type_info.

Deprecated:

GetType is unstable. Use IsType().

See Also: IsType

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

Get the type name value.

Returns: The type name.

template<typename Type >

bool sdf::Param::IsType ( ) const

Return true if the param is a particular type.

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

References sdf::ParamPrivate::value.

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

Equal operator.

Set's the value and default value from the provided Param.

Parameters

[in] _param The parameter to set values from.

Returns: *This

void sdf::Param::Reset ( )

Reset the parameter to the default value.

template<typename T >

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

Set the parameter's value.

The passed in value must conform to the boost::lexical_cast spec. This means the 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 sdf::ParamPrivate::key, sdferr, and SetFromString().

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

Set the description of the parameter.

Parameters

[in] _desc New description for the parameter.

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

Set the parameter value from a string.

Parameters

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

Referenced by Set().

template<typename T >

void sdf::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.

References sdf::ParamPrivate::updateFunc.

void sdf::Param::Update ( )

Set the parameter's value using the updateFunc.

See Also: Param::SetUpdateFunc

Friends And Related Function Documentation

std::ostream& operator<<	(	std::ostream &	_out,
		const Param &	_p
	)

friend

Ostream operator.

Outputs the parameter's value.

Parameters

[in]	_out	Output stream.
[in]	_p	The parameter to output.

Returns: The output stream.

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

Param.hh

Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation