sdf::ParamT< T > Class Template Reference

Templatized parameter class. More...

#include <Param.hh>

Inheritance diagram for sdf::ParamT< T >:

Public Member Functions
	ParamT (const std::string &_key, const std::string &_default, bool _required, const std::string &_typeName="", const std::string &_description="") GAZEBO_DEPRECATED(1.6)
	Constructor.
virtual	~ParamT () GAZEBO_DEPRECATED(1.6)
	Destructor.
virtual boost::shared_ptr< Param >	Clone () const GAZEBO_DEPRECATED(1.6)
virtual std::string	GetAsString () const GAZEBO_DEPRECATED(1.6)
	Get the parameter value as a string.
virtual std::string	GetDefaultAsString () const GAZEBO_DEPRECATED(1.6)
T	GetDefaultValue () const GAZEBO_DEPRECATED(1.6)
	Get the value.
T	GetValue () const GAZEBO_DEPRECATED(1.6)
	Get the value.
T	operator* () const GAZEBO_DEPRECATED(1.6)
virtual void	Reset () GAZEBO_DEPRECATED(1.6)
	Reset to default value.
virtual bool	Set (const std::string &_str) GAZEBO_DEPRECATED(1.6)
	Set the parameter value from a string.
virtual bool	SetFromString (const std::string &_value) GAZEBO_DEPRECATED(1.6)
	Set the parameter value from a string.
void	SetValue (const T &_value) GAZEBO_DEPRECATED(1.6)
	Set the value of the parameter.
virtual void	Update () GAZEBO_DEPRECATED(1.6)
	Update param value.
Public Member Functions inherited from sdf::Param
	Param (Param *_newParam) GAZEBO_DEPRECATED(1.6)
	Constructor.
virtual	~Param () GAZEBO_DEPRECATED(1.6)
	Destructor.
template<typename T >
bool	Get (T &_value)
	Get the value of the parameter.
bool	Get (bool &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (int &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (unsigned int &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (float &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (double &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (char &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (std::string &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (gazebo::math::Vector3 &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (gazebo::math::Vector2i &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (gazebo::math::Vector2d &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (gazebo::math::Quaternion &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (gazebo::math::Pose &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (gazebo::common::Color &_value) GAZEBO_DEPRECATED(1.6)
bool	Get (gazebo::common::Time &_value) GAZEBO_DEPRECATED(1.6)
std::string	GetDescription () const GAZEBO_DEPRECATED(1.6)
	Get the description of the parameter.
const std::string &	GetKey () const GAZEBO_DEPRECATED(1.6)
bool	GetRequired () const GAZEBO_DEPRECATED(1.6)
bool	GetSet () const GAZEBO_DEPRECATED(1.6)
	Return true if the parameter has been set.
std::string	GetTypeName () const GAZEBO_DEPRECATED(1.6)
bool	IsBool () const GAZEBO_DEPRECATED(1.6)
bool	IsChar () const GAZEBO_DEPRECATED(1.6)
bool	IsColor () const GAZEBO_DEPRECATED(1.6)
bool	IsDouble () const GAZEBO_DEPRECATED(1.6)
bool	IsFloat () const GAZEBO_DEPRECATED(1.6)
bool	IsInt () const GAZEBO_DEPRECATED(1.6)
bool	IsPose () const GAZEBO_DEPRECATED(1.6)
bool	IsQuaternion () const GAZEBO_DEPRECATED(1.6)
bool	IsStr () const GAZEBO_DEPRECATED(1.6)
bool	IsTime () const GAZEBO_DEPRECATED(1.6)
bool	IsUInt () const GAZEBO_DEPRECATED(1.6)
bool	IsVector2d () const GAZEBO_DEPRECATED(1.6)
bool	IsVector2i () const GAZEBO_DEPRECATED(1.6)
bool	IsVector3 () const GAZEBO_DEPRECATED(1.6)
bool	Set (const bool &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const int &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const unsigned int &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const float &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const double &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const char &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const char *_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const gazebo::math::Vector3 &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const gazebo::math::Vector2i &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const gazebo::math::Vector2d &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const gazebo::math::Quaternion &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const gazebo::math::Pose &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const gazebo::common::Color &_value) GAZEBO_DEPRECATED(1.6)
bool	Set (const gazebo::common::Time &_value) GAZEBO_DEPRECATED(1.6)
void	SetDescription (const std::string &_desc) GAZEBO_DEPRECATED(1.6)
	Set the description of the parameter.
template<typename T >
void	SetUpdateFunc (T _updateFunc)
	Update function.

Protected Attributes
T	defaultValue
T	value
Protected Attributes inherited from sdf::Param
std::string	description
std::string	key
bool	required
bool	set
std::string	typeName
boost::function< boost::any()>	updateFunc

Friends
std::ostream &	operator<< (std::ostream &_out, const ParamT< T > &_p) GAZEBO_DEPRECATED(1.6)

Detailed Description

template<typename T>
class sdf::ParamT< T >

Templatized parameter class.

Constructor & Destructor Documentation

template<typename T>

sdf::ParamT< T >::ParamT ( const std::string &  _key, const std::string &  _default, bool  _required, const std::string &  _typeName = "", const std::string &  _description = ""  )

inline

Constructor.

template<typename T>

virtual sdf::ParamT< T >::~ParamT ( )

inlinevirtual

Destructor.

Member Function Documentation

template<typename T>

virtual boost::shared_ptr<Param> sdf::ParamT< T >::Clone ( ) const

inlinevirtual

Implements sdf::Param.

template<typename T>

virtual std::string sdf::ParamT< T >::GetAsString ( ) const

inlinevirtual

Get the parameter value as a string.

Reimplemented from sdf::Param.

template<typename T>

virtual std::string sdf::ParamT< T >::GetDefaultAsString ( ) const

inlinevirtual

Reimplemented from sdf::Param.

template<typename T>

T sdf::ParamT< T >::GetDefaultValue ( ) const

inline

Get the value.

template<typename T>

T sdf::ParamT< T >::GetValue ( ) const

inline

Get the value.

template<typename T>

T sdf::ParamT< T >::operator* ( ) const

inline

template<typename T>

virtual void sdf::ParamT< T >::Reset ( )

inlinevirtual

Reset to default value.

Implements sdf::Param.

template<typename T>

virtual bool sdf::ParamT< T >::Set ( const std::string &  _str )

inlinevirtual

Set the parameter value from a string.

Reimplemented from sdf::Param.

template<typename T>

virtual bool sdf::ParamT< T >::SetFromString ( const std::string &  _value )

inlinevirtual

Set the parameter value from a string.

Reimplemented from sdf::Param.

template<typename T>

void sdf::ParamT< T >::SetValue ( const T &  _value )

inline

Set the value of the parameter.

template<typename T>

virtual void sdf::ParamT< T >::Update ( )

inlinevirtual

Update param value.

Implements sdf::Param.

Friends And Related Function Documentation

template<typename T>

std::ostream& operator<< ( std::ostream &  _out, const ParamT< T > &  _p  )

friend

Member Data Documentation

template<typename T>

T sdf::ParamT< T >::defaultValue

protected

template<typename T>

T sdf::ParamT< T >::value

protected

---

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

• Param.hh