Param Class Reference

A parameter class. More...

#include <Param.hh>

Inheritance diagram for Param:

List of all members.

Public Member Functions
	Param (Param *_newParam)
	Constructor.
virtual	~Param ()
	Destructor.
virtual std::string	GetAsString () const
	Get the type.
virtual std::string	GetDefaultAsString () const
virtual bool	SetFromString (const std::string &)
	Set the parameter value from a string.
virtual void	Reset ()=0
	Reset the parameter.
const std::string &	GetKey () const
std::string	GetTypeName () const
bool	GetRequired () const
bool	GetSet () const
	Return true if the parameter has been set.
virtual boost::shared_ptr< Param >	Clone () const =0
template<typename T >
void	SetUpdateFunc (T _updateFunc)
	Update function.
virtual void	Update ()=0
bool	IsBool () const
bool	IsInt () const
bool	IsUInt () const
bool	IsFloat () const
bool	IsDouble () const
bool	IsChar () const
bool	IsStr () const
bool	IsVector3 () const
bool	IsQuaternion () const
bool	IsPose () const
bool	IsColor () const
bool	Set (const bool &_value)
bool	Set (const int &_value)
bool	Set (const unsigned int &_value)
bool	Set (const float &_value)
bool	Set (const double &_value)
bool	Set (const char &_value)
bool	Set (const std::string &_value)
bool	Set (const char *_value)
bool	Set (const gazebo::math::Vector3 &_value)
bool	Set (const gazebo::math::Quaternion &_value)
bool	Set (const gazebo::math::Pose &_value)
bool	Set (const gazebo::common::Color &_value)
bool	Get (bool &_value)
bool	Get (int &_value)
bool	Get (unsigned int &_value)
bool	Get (float &_value)
bool	Get (double &_value)
bool	Get (char &_value)
bool	Get (std::string &_value)
bool	Get (gazebo::math::Vector3 &_value)
bool	Get (gazebo::math::Quaternion &_value)
bool	Get (gazebo::math::Pose &_value)
bool	Get (gazebo::common::Color &_value)
Static Public Member Functions
static void	Begin (std::vector< Param * > *_params)
	Begin a block of "new Param<*>".
static void	End ()
	End a block of "new Param<*>".
static ParamPtr	Find (Param_V &_params, const std::string &key)
	Find a parameter by name.
Protected Attributes
std::string	key
bool	required
bool	set
std::string	typeName
boost::function< boost::any()>	updateFunc

---

Detailed Description

A parameter class.

---

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

• Param.hh