A parameter class.
More...
#include <sdf/sdf.hh>
|
| 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.
|
◆ Param()
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. |
- Exceptions
-
Referenced by operator<<, and operator=().
◆ ~Param()
virtual sdf::Param::~Param |
( |
| ) |
|
|
virtual |
◆ Clone()
Clone the parameter.
- Returns
- A new parameter that is the clone of this.
References SetUpdateFunc().
◆ Get()
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 sdferr.
Referenced by GetAny().
◆ GetAny()
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 fetched _anyVal, false otherwise.
References Get(), and GetDefault().
◆ GetAsString()
std::string sdf::Param::GetAsString |
( |
| ) |
const |
Get the value as a string.
- Returns
- String containing the value of the parameter.
Referenced by operator<<.
◆ GetDefault()
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 sdferr.
Referenced by GetAny().
◆ GetDefaultAsString()
std::string sdf::Param::GetDefaultAsString |
( |
| ) |
const |
Get the default value as a string.
- Returns
- String containing the default value of the parameter.
◆ GetDescription()
std::string sdf::Param::GetDescription |
( |
| ) |
const |
Get the description of the parameter.
- Returns
- The description of the parameter.
◆ GetKey()
const std::string & sdf::Param::GetKey |
( |
| ) |
const |
Get the key value.
- Returns
- The key.
References IsType().
◆ GetRequired()
bool sdf::Param::GetRequired |
( |
| ) |
const |
Return whether the parameter is required.
- Returns
- True if the parameter is required.
◆ GetSet()
bool sdf::Param::GetSet |
( |
| ) |
const |
Return true if the parameter has been set.
- Returns
- True if the parameter has been set.
◆ GetTypeName()
const std::string & sdf::Param::GetTypeName |
( |
| ) |
const |
Get the type name value.
- Returns
- The type name.
◆ IsType()
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.
Referenced by GetKey().
◆ operator=()
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
References Param().
◆ Reset()
void sdf::Param::Reset |
( |
| ) |
|
Reset the parameter to the default value.
◆ Set()
template<typename T>
bool sdf::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().
Referenced by Update().
◆ SetDescription()
void sdf::Param::SetDescription |
( |
const std::string & | _desc | ) |
|
Set the description of the parameter.
- Parameters
-
[in] | _desc | New description for the parameter. |
◆ SetFromString()
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().
◆ SetUpdateFunc()
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. |
Referenced by Clone().
◆ Update()
void sdf::Param::Update |
( |
| ) |
|
The documentation for this class was generated from the following file: