OpenRTM-aist  1.2.1
Public Member Functions | Protected Attributes | List of all members
RTC::Config< VarType, TransFunc > Class Template Reference

Config class. More...

#include <ConfigAdmin.h>

Inheritance diagram for RTC::Config< VarType, TransFunc >:
Inheritance graph
[legend]
Collaboration diagram for RTC::Config< VarType, TransFunc >:
Collaboration graph
[legend]

Public Member Functions

 Config (const char *name, VarType &var, const char *def_val, TransFunc trans=coil::stringTo)
 Constructor. More...
 
virtual ~Config (void)
 Virtual Destructor. More...
 
virtual bool update (const char *val)
 Update a bind parameter value. More...
 
- Public Member Functions inherited from RTC::ConfigBase
 ConfigBase (const char *name_, const char *def_val)
 Constructer. More...
 
virtual ~ConfigBase (void)
 Virtual Destructor. More...
 
void setCallback (ConfigAdmin *cadmin, CallbackFunc cbf)
 Setting callback. More...
 
void notifyUpdate (const char *key, const char *val)
 Observer function to notify variable changed. More...
 

Protected Attributes

VarType & m_var
 Configuration parameter variable. More...
 
TransFunc m_trans
 Transformation function to convert configuration parameter type into string format. More...
 
- Protected Attributes inherited from RTC::ConfigBase
std::string string_value
 Current value in string format. More...
 
ConfigAdminm_admin
 A pointer to the ConfigAdmin object. More...
 
CallbackFunc m_callback
 A member function pointer to the callback function. More...
 

Additional Inherited Members

- Public Types inherited from RTC::ConfigBase
typedef void(ConfigAdmin::* CallbackFunc) (const char *, const char *)
 
- Public Attributes inherited from RTC::ConfigBase
const char * name
 Configuration name. More...
 
const char * default_value
 Default value in string format. More...
 

Detailed Description

template<typename VarType, typename TransFunc = bool (*)(VarType&, const char*)>
class RTC::Config< VarType, TransFunc >

Config class.

Class to hold the configuration parameter information. Specify the data type of the configuration as <VarType> Specify transformation function to convert data type set as <TransFunc> into string format.

Parameters
VarTypeCariable to hold configuration parameter
TransFuncTransformation function to transform the stored data type into string format.
Since
0.4.0

Constructor & Destructor Documentation

template<typename VarType, typename TransFunc = bool (*)(VarType&, const char*)>
RTC::Config< VarType, TransFunc >::Config ( const char *  name,
VarType &  var,
const char *  def_val,
TransFunc  trans = coil::stringTo 
)
inline

Constructor.

Constructor

Parameters
nameConfiguration parameter name
varConfiguration parameter variable
def_valDefault value in string format
transFunction to transform into string format
template<typename VarType, typename TransFunc = bool (*)(VarType&, const char*)>
virtual RTC::Config< VarType, TransFunc >::~Config ( void  )
inlinevirtual

Virtual Destructor.

Virtual Destructor.

Member Function Documentation

template<typename VarType, typename TransFunc = bool (*)(VarType&, const char*)>
virtual bool RTC::Config< VarType, TransFunc >::update ( const char *  val)
inlinevirtual

Update a bind parameter value.

Update configuration paramater by the configuration value.

Parameters
valThe parameter values converted into character string format
Returns
Update result (Successful:true, Failed:false)

Implements RTC::ConfigBase.

References RTC::ConfigBase::default_value, RTC::ConfigBase::name, RTC::ConfigBase::notifyUpdate(), and RTC::ConfigBase::string_value.

Member Data Documentation

template<typename VarType, typename TransFunc = bool (*)(VarType&, const char*)>
TransFunc RTC::Config< VarType, TransFunc >::m_trans
protected

Transformation function to convert configuration parameter type into string format.

template<typename VarType, typename TransFunc = bool (*)(VarType&, const char*)>
VarType& RTC::Config< VarType, TransFunc >::m_var
protected

Configuration parameter variable.


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