OpenRTM  1.0.0
Public Member Functions | Public Attributes | List of all members
RTC::ConfigBase Class Referenceabstract

ConfigBase abstract class. More...

#include <ConfigAdmin.h>

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

Public Member Functions

 ConfigBase (const char *name_, const char *def_val)
 Constructer. More...
 
virtual ~ConfigBase (void)
 Virtual Destructor. More...
 
virtual bool update (const char *val)=0
 Pure virtual function to update configuration parameter values. More...
 

Public Attributes

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

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

Constructor & Destructor Documentation

◆ ConfigBase()

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

Constructer.

Constructer

Parameters
name_Configuration name
def_valDefault value in string format

◆ ~ConfigBase()

virtual RTC::ConfigBase::~ConfigBase ( void  )
inlinevirtual

Virtual Destructor.

Virtual Destructor

References update().

Member Function Documentation

◆ update()

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
valThe parameter values converted into character string format
Returns
Result of the setup

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

Referenced by RTC::ConfigAdmin::bindParameter(), and ~ConfigBase().

Member Data Documentation

◆ default_value

const char* RTC::ConfigBase::default_value

Default value in string format.

Referenced by RTC::Config< VarType, TransFunc >::update().

◆ name

const char* RTC::ConfigBase::name

Configuration name.

Referenced by RTC::ConfigAdmin::bindParameter(), and RTC::ConfigAdmin::isActive().