RTC::Config< VarType, TransFunc > Class Template Reference

Config class. More...

#include <ConfigAdmin.h>

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

List of all members.

Public Member Functions
	Config (const char *name, VarType &var, const char *def_val, TransFunc trans=coil::stringTo)
	Constructor.
virtual bool	update (const char *val)
	Update a bind parameter value.
virtual	~Config (void)
Protected Attributes
TransFunc	m_trans
	Transformation function to convert configuration parameter type into string format.
VarType &	m_var
	Configuration parameter variable.

---

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:

VarType	Cariable to hold configuration parameter
TransFunc	Transformation function to transform the stored data type into string format.

Since:

0.4.0

Definition at line 283 of file ConfigAdmin.h.

---

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:

name	Configuration parameter name
var	Configuration parameter variable
def_val	Default value in string format
trans	Function to transform into string format

Definition at line 312 of file ConfigAdmin.h.

template<typename VarType, typename TransFunc = bool (*)(VarType&, const char*)>

virtual RTC::Config< VarType, TransFunc >::~Config

(

void

)

[inline, virtual]

Virtual Destructor.

Definition at line 333 of file ConfigAdmin.h.

---

Member Function Documentation

template<typename VarType, typename TransFunc = bool (*)(VarType&, const char*)>

virtual bool RTC::Config< VarType, TransFunc >::update

(

const char *

val

)

[inline, virtual]

Update a bind parameter value.

Update configuration paramater by the configuration value.

Parameters:

val	The parameter values converted into character string format

Returns:

Update result (Successful:true, Failed:false)

Implements RTC::ConfigBase.

Definition at line 358 of file ConfigAdmin.h.

---

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.

Definition at line 383 of file ConfigAdmin.h.

template<typename VarType, typename TransFunc = bool (*)(VarType&, const char*)>

VarType& RTC::Config< VarType, TransFunc >::m_var [protected]

Configuration parameter variable.

Definition at line 373 of file ConfigAdmin.h.

---

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

• ConfigAdmin.h