Classes | Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
RTC::ConfigAdmin Class Reference

ConfigAdmin class. More...

#include <ConfigAdmin.h>

Inheritance diagram for RTC::ConfigAdmin:
Inheritance graph
[legend]

Classes

struct  find_conf
 

Public Member Functions

bool activateConfigurationSet (const char *config_id)
 Activate the configuration set. More...
 
void addConfigurationParamListener (ConfigurationParamListenerType type, ConfigurationParamListener *listener, bool autoclean=true)
 Adding ConfigurationParamListener. More...
 
bool addConfigurationSet (const coil::Properties &configuration_set)
 Add the configuration value to configuration set. More...
 
void addConfigurationSetListener (ConfigurationSetListenerType type, ConfigurationSetListener *listener, bool autoclean=true)
 Adding ConfigurationSetListener. More...
 
void addConfigurationSetNameListener (ConfigurationSetNameListenerType type, ConfigurationSetNameListener *listener, bool autoclean=true)
 Adding ConfigurationSetNameListener. More...
 
template<typename VarType >
bool bindParameter (const char *param_name, VarType &var, const char *def_val, bool(*trans)(VarType &, const char *)=coil::stringTo)
 Setup for configuration parameters. More...
 
 ConfigAdmin (coil::Properties &prop)
 Constructor. More...
 
const coil::PropertiesgetActiveConfigurationSet (void)
 Get the active configuration set. More...
 
const char * getActiveId (void)
 Get ID of active configuration set. More...
 
const coil::PropertiesgetConfigurationSet (const char *config_id)
 Get a configuration set by specified ID. More...
 
const std::vector< coil::Properties * > & getConfigurationSets (void)
 Get all configuration sets. More...
 
bool haveConfig (const char *config_id)
 Check the existence of configuration set. More...
 
bool isActive (void)
 Confirm to activate configuration set. More...
 
bool isChanged (void)
 Confirm to change configuration parameters. More...
 
bool isExist (const char *name)
 Check the existence of configuration parameters. More...
 
void removeConfigurationParamListener (ConfigurationParamListenerType type, ConfigurationParamListener *listener)
 Removing ConfigurationParamListener. More...
 
bool removeConfigurationSet (const char *config_id)
 Remove the configuration set. More...
 
void removeConfigurationSetListener (ConfigurationSetListenerType type, ConfigurationSetListener *listener)
 Removing ConfigurationSetListener. More...
 
void removeConfigurationSetNameListener (ConfigurationSetNameListenerType type, ConfigurationSetNameListener *listener)
 Removing ConfigurationSetNameListener. More...
 
bool setConfigurationSetValues (const coil::Properties &configuration_set)
 Add to configuration set from specified property. More...
 
void setOnActivateSet (OnActivateSetCallback *cb)
 
void setOnAddConfigurationSet (OnAddConfigurationAddCallback *cb)
 
void setOnRemoveConfigurationSet (OnRemoveConfigurationSetCallback *cb)
 
void setOnSetConfigurationSet (OnSetConfigurationSetCallback *cb)
 
void setOnUpdate (OnUpdateCallback *cb)
 
void setOnUpdateParam (OnUpdateParamCallback *cb)
 
void update (void)
 Update the values of configuration parameters (Active configuration set) More...
 
void update (const char *config_set)
 Update configuration parameter (By ID) More...
 
void update (const char *config_set, const char *config_param)
 Update the values of configuration parameters (By name) More...
 
 ~ConfigAdmin (void)
 Virtual Destructor. More...
 

Protected Member Functions

void onActivateSet (const char *config_id)
 Called when the configuration set is made active. More...
 
void onAddConfigurationSet (const coil::Properties &config_set)
 Called when a set value is added to the configuration set. More...
 
void onRemoveConfigurationSet (const char *config_id)
 Called when the configuration set has been deleted. More...
 
void onSetConfigurationSet (const coil::Properties &config_set)
 Called when the property is added to the configuration set. More...
 
void onUpdate (const char *config_set)
 When the configuration parameter is updated, it is called. More...
 
void onUpdateParam (const char *config_set, const char *config_param)
 When the configuration parameter is updated, it is called. More...
 

Private Member Functions

 ConfigAdmin (const ConfigAdmin &ca)
 
ConfigAdminoperator= (const ConfigAdmin &ca)
 

Private Attributes

bool m_active
 
std::string m_activeId
 
bool m_changed
 
coil::Propertiesm_configsets
 
coil::Properties m_emptyconf
 
ConfigurationListeners m_listeners
 
std::vector< std::string > m_newConfig
 
std::vector< ConfigBase * > m_params
 

Detailed Description

ConfigAdmin class.

Class to manage various configuration information. Now terms for this class are defined as follows.

The following two configuration informations are stored in this class.

  1. A list of configuration-set
  2. A list of configuration parameter variables

Basically, the purpose of this class is to set one of the configuration-set in the list of (1) into parameter variables of (2). Usually, configuration parameter variables manipulation is performed with two-phases of configuration-set setting and parameter variables setting.

The configuration-set manipulations are performed by the following functions.

Modification, addition, deletion, acquisition and activation of configuration-set are performed by these functions. In order to reflect configuration-set, which is manipulated by these functions, on parameter variables that are used from RTC activities, the following update() functions are used .

Callback functors can be given to hook configuration operation. Operations to be hooked are as follows.

Since
0.4.0

Definition at line 534 of file ConfigAdmin.h.

Constructor & Destructor Documentation

◆ ConfigAdmin() [1/2]

RTC::ConfigAdmin::ConfigAdmin ( coil::Properties prop)

Constructor.

Constructor

Parameters
propThe target property name for setup

Definition at line 32 of file ConfigAdmin.cpp.

◆ ~ConfigAdmin()

RTC::ConfigAdmin::~ConfigAdmin ( void  )

Virtual Destructor.

Virtual destructor.

Virtual Destructor

Definition at line 45 of file ConfigAdmin.cpp.

◆ ConfigAdmin() [2/2]

RTC::ConfigAdmin::ConfigAdmin ( const ConfigAdmin ca)
private

Member Function Documentation

◆ activateConfigurationSet()

bool RTC::ConfigAdmin::activateConfigurationSet ( const char *  config_id)

Activate the configuration set.

Activate the configuration set of specified ID Return empty configuration set, if a configuration set of specified ID doesn't exist.

Parameters
config_idID of the target configuration set for remove
Returns
Activate result (Remove success:trueĦ˘Remove failure:false)

Definition at line 265 of file ConfigAdmin.cpp.

◆ addConfigurationParamListener()

void RTC::ConfigAdmin::addConfigurationParamListener ( ConfigurationParamListenerType  type,
ConfigurationParamListener listener,
bool  autoclean = true 
)

Adding ConfigurationParamListener.

This function adds a listener object which is called when update(const char* config_set, const char* config_param) is called. In the type argument, currently only ON_UPDATE_CONFIG_PARAM is allowed.

Parameters
typeConfigurationParamListenerType value ON_UPDATE_CONFIG_PARAM is only allowed.
listenerConfigurationParamListener listener object.
autocleana flag whether if the listener object autocleaned.

Definition at line 336 of file ConfigAdmin.cpp.

◆ addConfigurationSet()

bool RTC::ConfigAdmin::addConfigurationSet ( const coil::Properties configuration_set)

Add the configuration value to configuration set.

Add the configuration value to the configuration set.

Add the configuration value to configuration set

Parameters
configuration_setProperty to add
Returns
Add Result (Successful:true, Failed:false)

Definition at line 215 of file ConfigAdmin.cpp.

◆ addConfigurationSetListener()

void RTC::ConfigAdmin::addConfigurationSetListener ( ConfigurationSetListenerType  type,
ConfigurationSetListener listener,
bool  autoclean = true 
)

Adding ConfigurationSetListener.

This function add a listener object which is called when ConfigurationSet is updated. Available events are the followings.

Parameters
typeConfigurationSetListenerType value
listenerConfigurationSetListener listener object.
autocleana flag whether if the listener object autocleaned.

Definition at line 365 of file ConfigAdmin.cpp.

◆ addConfigurationSetNameListener()

void RTC::ConfigAdmin::addConfigurationSetNameListener ( ConfigurationSetNameListenerType  type,
ConfigurationSetNameListener listener,
bool  autoclean = true 
)

Adding ConfigurationSetNameListener.

This function add a listener object which is called when ConfigurationSetName is updated. Available events are the followings.

  • ON_UPDATE_CONFIG_SET: A ConfigurationSet has been updated.
  • ON_REMOVE_CONFIG_SET: A ConfigurationSet has been deleted.
  • ON_ACTIVATE_CONFIG_SET: A ConfigurationSet has been activated.
Parameters
typeConfigurationSetNameListenerType value
listenerConfigurationSetNameListener listener object.
autocleana flag whether if the listener object autocleaned.

Definition at line 394 of file ConfigAdmin.cpp.

◆ bindParameter()

template<typename VarType >
bool RTC::ConfigAdmin::bindParameter ( const char *  param_name,
VarType &  var,
const char *  def_val,
bool(*)(VarType &, const char *)  trans = coil::stringTo 
)
inline

Setup for configuration parameters.

Bind configuration parameter to its variable. Return false, if configuration parameter of specified name has already existed. Specify the data type of the configuration as <VarType>.

Parameters
param_nameConfiguration parameter name
varConfiguration parameter variable
def_valDefault value of configuration parameter
transFunction to transform configuration parameter type into string format
Returns
Setup result (Successful:true, Failed:false)

Definition at line 612 of file ConfigAdmin.h.

◆ getActiveConfigurationSet()

const coil::Properties & RTC::ConfigAdmin::getActiveConfigurationSet ( void  )

Get the active configuration set.

Get the current active configuration set. Return empty configuration set, if an active configuration set doesn't exist.

Returns
The active configuration set

Definition at line 201 of file ConfigAdmin.cpp.

◆ getActiveId()

const char* RTC::ConfigAdmin::getActiveId ( void  )
inline

Get ID of active configuration set.

Get ID of the current active configuration set.

Returns
The active configuration set ID

Definition at line 796 of file ConfigAdmin.h.

◆ getConfigurationSet()

const coil::Properties & RTC::ConfigAdmin::getConfigurationSet ( const char *  config_id)

Get a configuration set by specified ID.

Get a configuration set that was specified by ID Return empty configuration set, if a configuration set of specified ID doesn't exist.

Parameters
config_idID of the target configuration set for getting
Returns
The configuration set

Definition at line 165 of file ConfigAdmin.cpp.

◆ getConfigurationSets()

const std::vector< coil::Properties * > & RTC::ConfigAdmin::getConfigurationSets ( void  )

Get all configuration sets.

Get all specified configuration sets

Returns
All configuration sets

Definition at line 152 of file ConfigAdmin.cpp.

◆ haveConfig()

bool RTC::ConfigAdmin::haveConfig ( const char *  config_id)
inline

Check the existence of configuration set.

Check the existence of specified configuration set.

Parameters
config_idID of target configuration set for confirmation
Returns
Result of existence confirmation (Specified ConfigSet exists:true, else:false)

Definition at line 822 of file ConfigAdmin.h.

◆ isActive()

bool RTC::ConfigAdmin::isActive ( void  )
inline

Confirm to activate configuration set.

Confirm that configuration set has been activated.

Returns
Result of state confirmation (Active state:true, Inactive state:false)

Definition at line 847 of file ConfigAdmin.h.

◆ isChanged()

bool RTC::ConfigAdmin::isChanged ( void  )
inline

Confirm to change configuration parameters.

Confirm that configuration parameters have changed.

Returns
Result of change confirmation (There is a change:trueĦ˘No change:false)

Definition at line 775 of file ConfigAdmin.h.

◆ isExist()

bool RTC::ConfigAdmin::isExist ( const char *  name)

Check the existence of configuration parameters.

Check the existence of configuration parameters of specified name.

Parameters
nameConfiguration parameter name
Returns
Result of existance confirmation (Parameters exist:true, else:false)

Definition at line 132 of file ConfigAdmin.cpp.

◆ onActivateSet()

void RTC::ConfigAdmin::onActivateSet ( const char *  config_id)
protected

Called when the configuration set is made active.

Call the set callback object.

Parameters
config_idproperty

Definition at line 486 of file ConfigAdmin.cpp.

◆ onAddConfigurationSet()

void RTC::ConfigAdmin::onAddConfigurationSet ( const coil::Properties config_set)
protected

Called when a set value is added to the configuration set.

Call the set callback object.

Parameters
configuration_setproperty

Definition at line 462 of file ConfigAdmin.cpp.

◆ onRemoveConfigurationSet()

void RTC::ConfigAdmin::onRemoveConfigurationSet ( const char *  config_id)
protected

Called when the configuration set has been deleted.

Call the set callback object.

Parameters
config_idproperty

Definition at line 474 of file ConfigAdmin.cpp.

◆ onSetConfigurationSet()

void RTC::ConfigAdmin::onSetConfigurationSet ( const coil::Properties config_set)
protected

Called when the property is added to the configuration set.

Call the set callback object.

Parameters
configuration_setproperty

Definition at line 450 of file ConfigAdmin.cpp.

◆ onUpdate()

void RTC::ConfigAdmin::onUpdate ( const char *  config_set)
protected

When the configuration parameter is updated, it is called.

Call the set callback object.

Parameters
config_setThe target configuration set's ID to setup

Definition at line 424 of file ConfigAdmin.cpp.

◆ onUpdateParam()

void RTC::ConfigAdmin::onUpdateParam ( const char *  config_set,
const char *  config_param 
)
protected

When the configuration parameter is updated, it is called.

Call the set callback object.

Parameters
config_setconfiguration-set ID.
config_paramconfiguration parameter name.

Definition at line 437 of file ConfigAdmin.cpp.

◆ operator=()

ConfigAdmin& RTC::ConfigAdmin::operator= ( const ConfigAdmin ca)
private

◆ removeConfigurationParamListener()

void RTC::ConfigAdmin::removeConfigurationParamListener ( ConfigurationParamListenerType  type,
ConfigurationParamListener listener 
)

Removing ConfigurationParamListener.

This function removes a listener object which is added by addConfigurationParamListener() function.

Parameters
typeConfigurationParamListenerType value ON_UPDATE_CONFIG_PARAM is only allowed.
listenera pointer to ConfigurationParamListener listener object.

Definition at line 351 of file ConfigAdmin.cpp.

◆ removeConfigurationSet()

bool RTC::ConfigAdmin::removeConfigurationSet ( const char *  config_id)

Remove the configuration set.

Remove the configuration set of specified ID Return empty configuration set, if a configuration set of specified ID doesn't exist.

The configuration-sets that can be removed by this function are only configuration-sets newly added by the addConfigurationSet() function. The configuration that can be removed by this function is only newly added configuration-set by addConfigurationSet() function. The "default" configuration-set and configurationi-sets that is loaded from configuration file cannot be removed.

If the specified configuration is active currently, any configurations are not deleted.

Callback functions that are set by addOnRemovedConfigurationSet() will be called if a configuration-set is deleted actually by this function.

Parameters
config_idID of the target configuration set for remove
Returns
Remove result (Successful:true, Failed:false)

Definition at line 238 of file ConfigAdmin.cpp.

◆ removeConfigurationSetListener()

void RTC::ConfigAdmin::removeConfigurationSetListener ( ConfigurationSetListenerType  type,
ConfigurationSetListener listener 
)

Removing ConfigurationSetListener.

This function removes a listener object which is added by addConfigurationSetListener() function.

Parameters
typeConfigurationSetListenerType value
listenera pointer to ConfigurationSetListener listener object.

Definition at line 380 of file ConfigAdmin.cpp.

◆ removeConfigurationSetNameListener()

void RTC::ConfigAdmin::removeConfigurationSetNameListener ( ConfigurationSetNameListenerType  type,
ConfigurationSetNameListener listener 
)

Removing ConfigurationSetNameListener.

This function removes a listener object which is added by addConfigurationSetNameListener() function.

Parameters
typeConfigurationSetNameListenerType value ON_UPDATE_CONFIG_PARAM is only allowed.
listenera pointer to ConfigurationSetNameListener listener object.

Definition at line 409 of file ConfigAdmin.cpp.

◆ setConfigurationSetValues()

bool RTC::ConfigAdmin::setConfigurationSetValues ( const coil::Properties configuration_set)

Add to configuration set from specified property.

Add to the configuration set from specified property.

Add specified property to configuration set that was specified by ID. Return false if configuration set, that matches specified ID, doesn't exist.

Parameters
config_idID of the target configuration set for add
configuration_setProperty to add
Returns
Add result (Successful:true, Failed:false)

Definition at line 180 of file ConfigAdmin.cpp.

◆ setOnActivateSet()

void RTC::ConfigAdmin::setOnActivateSet ( OnActivateSetCallback cb)

Definition at line 318 of file ConfigAdmin.cpp.

◆ setOnAddConfigurationSet()

void RTC::ConfigAdmin::setOnAddConfigurationSet ( OnAddConfigurationAddCallback cb)

Definition at line 303 of file ConfigAdmin.cpp.

◆ setOnRemoveConfigurationSet()

void RTC::ConfigAdmin::setOnRemoveConfigurationSet ( OnRemoveConfigurationSetCallback cb)

Definition at line 311 of file ConfigAdmin.cpp.

◆ setOnSetConfigurationSet()

void RTC::ConfigAdmin::setOnSetConfigurationSet ( OnSetConfigurationSetCallback cb)

Definition at line 296 of file ConfigAdmin.cpp.

◆ setOnUpdate()

void RTC::ConfigAdmin::setOnUpdate ( OnUpdateCallback cb)

Definition at line 282 of file ConfigAdmin.cpp.

◆ setOnUpdateParam()

void RTC::ConfigAdmin::setOnUpdateParam ( OnUpdateParamCallback cb)

Definition at line 289 of file ConfigAdmin.cpp.

◆ update() [1/3]

void RTC::ConfigAdmin::update ( void  )

Update the values of configuration parameters (Active configuration set)

When configuration set is updated, update the configuration parameter value to the value that is set to the current active configuration. This update will be executed, only when an active configuration set exists and the content of the configuration set has been updated from the last update.

Definition at line 64 of file ConfigAdmin.cpp.

◆ update() [2/3]

void RTC::ConfigAdmin::update ( const char *  config_set)

Update configuration parameter (By ID)

This operation updates configuration variables by the configuration-set with specified ID. This operation does not change current active configuration-set. Since this operation causes inconsistency between current active configuration set and actual values of configuration variables, user should carefully use it.

This operation ends without doing anything, if the configuration-set does not exist.

Parameters
config_setThe target configuration set's ID to setup

Definition at line 82 of file ConfigAdmin.cpp.

◆ update() [3/3]

void RTC::ConfigAdmin::update ( const char *  config_set,
const char *  config_param 
)

Update the values of configuration parameters (By name)

This operation updates a configuration variable by the specified configuration parameter in the configuration-set. This operation does not change current active configuration-set. Since this operation causes inconsistency between current active configuration set and actual values of configuration variables, user should carefully use it.

This operation ends without doing anything, if the configuration-set or the configuration parameter do not exist.

Parameters
config_setconfiguration-set ID.
config_paramconfiguration parameter name.

Definition at line 106 of file ConfigAdmin.cpp.

Member Data Documentation

◆ m_active

bool RTC::ConfigAdmin::m_active
private

Definition at line 1429 of file ConfigAdmin.h.

◆ m_activeId

std::string RTC::ConfigAdmin::m_activeId
private

Definition at line 1428 of file ConfigAdmin.h.

◆ m_changed

bool RTC::ConfigAdmin::m_changed
private

Definition at line 1430 of file ConfigAdmin.h.

◆ m_configsets

coil::Properties& RTC::ConfigAdmin::m_configsets
private

Definition at line 1425 of file ConfigAdmin.h.

◆ m_emptyconf

coil::Properties RTC::ConfigAdmin::m_emptyconf
private

Definition at line 1426 of file ConfigAdmin.h.

◆ m_listeners

ConfigurationListeners RTC::ConfigAdmin::m_listeners
private

Definition at line 1432 of file ConfigAdmin.h.

◆ m_newConfig

std::vector<std::string> RTC::ConfigAdmin::m_newConfig
private

Definition at line 1431 of file ConfigAdmin.h.

◆ m_params

std::vector<ConfigBase*> RTC::ConfigAdmin::m_params
private

Definition at line 1427 of file ConfigAdmin.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:47