RTC::ConfigBase Class Reference

ConfigBase abstract class. More...

#include <ConfigAdmin.h>

Inheritance diagram for RTC::ConfigBase:
RTC::Config< VarType, TransFunc >

List of all members.

Public Types

typedef void(ConfigAdmin::* CallbackFunc )(const char *, const char *)

Public Member Functions

 ConfigBase (const char *name_, const char *def_val)
 Constructer.
virtual ~ConfigBase (void)
 Virtual Destructor.
void setCallback (ConfigAdmin *cadmin, CallbackFunc cbf)
 Setting callback.
void notifyUpdate (const char *key, const char *val)
 Observer function to notify variable changed.
virtual bool update (const char *val)=0
 Pure virtual function to update configuration parameter values.

Public Attributes

const char * name
 Configuration name.
const char * default_value
 Default value in string format.

Protected Attributes

std::string string_value
 Current value in string format.
ConfigAdminm_admin
 A pointer to the ConfigAdmin object.
CallbackFunc m_callback
 A member function pointer to the callback function.

Detailed Description

ConfigBase abstract class.

This is the abstract interface class to hold various configuration information. Concrete configuration classes must implement the following pure virtual functions.

This class provides public interface as follows.

Since:
0.4.0

Member Typedef Documentation

typedef void(ConfigAdmin::* RTC::ConfigBase::CallbackFunc)(const char *, const char *)

Constructor & Destructor Documentation

RTC::ConfigBase::ConfigBase ( const char *  name_,
const char *  def_val 
) [inline]

Constructer.

Constructer

Parameters:
name_ Configuration name
def_val Default value in string format
virtual RTC::ConfigBase::~ConfigBase ( void   )  [inline, virtual]

Virtual Destructor.

Virtual Destructor


Member Function Documentation

void RTC::ConfigBase::notifyUpdate ( const char *  key,
const char *  val 
)

Observer function to notify variable changed.

This function notifies variable has been changed.

void RTC::ConfigBase::setCallback ( ConfigAdmin cadmin,
CallbackFunc  cbf 
)

Setting callback.

This member function sets callback function which is called when variable is changed.

Referenced by RTC::ConfigAdmin::bindParameter().

virtual bool RTC::ConfigBase::update ( const char *  val  )  [pure virtual]

Pure virtual function to update configuration parameter values.

Pure virtual function to update configuration parameter by the configuration value.

Parameters:
val The parameter values converted into character string format
Returns:
Result of the setup

Implemented in RTC::Config< VarType, TransFunc >.


Member Data Documentation

Default value in string format.

A pointer to the ConfigAdmin object.

A member function pointer to the callback function.

const char* RTC::ConfigBase::name

Configuration name.

std::string RTC::ConfigBase::string_value [protected]

Current value in string format.

Generated on Sat Apr 19 14:45:45 2014 for OpenRTM by  doxygen 1.6.3