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. | |
virtual | ~Param () |
Destructor. | |
ParamPtr | Clone () const |
Clone the parameter. | |
template<typename T > | |
bool | Get (T &_value) const |
Get the value of the parameter. | |
bool | GetAny (boost::any &_anyVal) const |
Get the value of the parameter as a boost::any. | |
std::string | GetAsString () const |
Get the value as a string. | |
template<typename T > | |
bool | GetDefault (T &_value) const |
Get the default value of the parameter. | |
std::string | GetDefaultAsString () const |
Get the default value as a string. | |
std::string | GetDescription () const |
Get the description of the parameter. | |
const std::string & | GetKey () const |
Get the key value. | |
bool | GetRequired () const |
Return whether the parameter is required. | |
bool | GetSet () const |
Return true if the parameter has been set. | |
const std::string & | GetTypeName () const |
Get the type name value. | |
template<typename Type > | |
bool | IsType () const |
Return true if the param is a particular type. | |
Param & | operator= (const Param &_param) |
Equal operator. | |
void | Reset () |
Reset the parameter to the default value. | |
template<typename T > | |
bool | Set (const T &_value) |
Set the parameter's value. | |
void | SetDescription (const std::string &_desc) |
Set the description of the parameter. | |
bool | SetFromString (const std::string &_value) |
Set the parameter value from a string. | |
template<typename T > | |
void | SetUpdateFunc (T _updateFunc) |
Set the update function. | |
void | Update () |
Set the parameter's value using the updateFunc. | |
A parameter class.
sdf::Param::Param | ( | const std::string & | _key, |
const std::string & | _typeName, | ||
const std::string & | _default, | ||
bool | _required, | ||
const std::string & | _description = "" ) |
Constructor.
[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. |
sdf::AssertionInternalError | if an invalid type is given. |
|
virtual |
Destructor.
ParamPtr sdf::Param::Clone | ( | ) | const |
Clone the parameter.
bool sdf::Param::Get | ( | T & | _value | ) | const |
Get the value of the parameter.
[out] | _value | The value of the parameter. |
Referenced by Get(), GetDefault(), IsType(), Set(), and SetUpdateFunc().
bool sdf::Param::GetAny | ( | boost::any & | _anyVal | ) | const |
Get the value of the parameter as a boost::any.
[out] | _anyVal | The boost::any object to set. |
std::string sdf::Param::GetAsString | ( | ) | const |
Get the value as a string.
std::string sdf::Param::GetDefaultAsString | ( | ) | const |
Get the default value as a string.
std::string sdf::Param::GetDescription | ( | ) | const |
Get the description of the parameter.
const std::string & sdf::Param::GetKey | ( | ) | const |
Get the key value.
bool sdf::Param::GetRequired | ( | ) | const |
Return whether the parameter is required.
bool sdf::Param::GetSet | ( | ) | const |
Return true if the parameter has been set.
const std::string & sdf::Param::GetTypeName | ( | ) | const |
Get the type name value.
Param & sdf::Param::operator= | ( | const Param & | _param | ) |
Equal operator.
Set's the value and default value from the provided Param.
[in] | _param | The parameter to set values from. |
void sdf::Param::Reset | ( | ) |
Reset the parameter to the default value.
Set the parameter's value.
The passed in value value must have an input and output stream operator.
[in] | _value | The value to set the parameter to. |
References Get(), sdferr, and SetFromString().
Set the description of the parameter.
[in] | _desc | New description for the parameter. |
Set the parameter value from a string.
[in] | _value | New value for the parameter in string form. |
Referenced by Set().
Set the update function.
The updateFunc will be used to set the parameter's value when Param::Update is called.
[in] | _updateFunc | Function pointer to an update function. |
References Get().
void sdf::Param::Update | ( | ) |
Set the parameter's value using the updateFunc.