クラス RTC::ConfigAdmin

ConfigAdmin クラス [詳細]

#include <ConfigAdmin.h>

すべてのメンバ一覧

Public メソッド

 ConfigAdmin (coil::Properties &prop)
 コンストラクタ
 ~ConfigAdmin (void)
 仮想デストラクタ
template<typename VarType>
bool bindParameter (const char *param_name, VarType &var, const char *def_val, bool(*trans)(VarType &, const char *)=coil::stringTo)
 コンフィギュレーションパラメータの設定
void update (const char *config_set)
 コンフィギュレーションパラメータの更新(ID指定)
void update (const char *config_set, const char *config_param)
 コンフィギュレーションパラメータの更新(名称指定)
void update (void)
 コンフィギュレーションパラメータの更新 (アクティブコンフィギュレーションセット)
bool isExist (const char *name)
 コンフィギュレーションパラメータの存在確認
bool isChanged (void)
 コンフィギュレーションパラメータの変更確認
const char * getActiveId (void)
 アクティブ・コンフィギュレーションセットIDの取得
bool haveConfig (const char *config_id)
 コンフィギュレーションセットの存在確認
bool isActive (void)
 コンフィギュレーションセットのアクティブ化確認
const std::vector
< coil::Properties * > & 
getConfigurationSets (void)
 全コンフィギュレーションセットの取得
const coil::Properties & getConfigurationSet (const char *config_id)
 指定したIDのコンフィギュレーションセットの取得
bool setConfigurationSetValues (const coil::Properties &configuration_set)
 指定したプロパティのコンフィギュレーションセットへの追加
const coil::Properties & getActiveConfigurationSet (void)
 アクティブ・コンフィギュレーションセットを取得
bool addConfigurationSet (const coil::Properties &configuration_set)
 コンフィギュレーションセットに設定値を追加
bool removeConfigurationSet (const char *config_id)
 コンフィギュレーションセットの削除
bool activateConfigurationSet (const char *config_id)
 コンフィギュレーションセットのアクティブ化
void setOnUpdate (OnUpdateCallback *cb)
void setOnUpdateParam (OnUpdateParamCallback *cb)
void setOnSetConfigurationSet (OnSetConfigurationSetCallback *cb)
void setOnAddConfigurationSet (OnAddConfigurationAddCallback *cb)
void setOnRemoveConfigurationSet (OnRemoveConfigurationSetCallback *cb)
void setOnActivateSet (OnActivateSetCallback *cb)

Protected メソッド

void onUpdate (const char *config_set)
void onUpdateParam (const char *config_set, const char *config_param)
void onSetConfigurationSet (const coil::Properties &config_set)
void onAddConfigurationSet (const coil::Properties &config_set)
void onRemoveConfigurationSet (const char *config_id)
void onActivateSet (const char *config_id)

構成

struct  find_conf


説明

ConfigAdmin クラス

各種コンフィギュレーション情報を管理するクラス。

から:
0.4.0

コンストラクタとデストラクタ

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

コンストラクタ

コンストラクタ

引数:
prop 設定対象プロパティ名

RTC::ConfigAdmin::~ConfigAdmin ( void   ) 

仮想デストラクタ

仮想デストラクタ。


関数

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]

コンフィギュレーションパラメータの設定

コンフィギュレーションパラメータと変数をバインドする 指定した名称のコンフィギュレーションパラメータが既に存在する場合は falseを返す。 <VarType>としてコンフィギュレーションパラメータのデータ型を指定する。

引数:
param_name コンフィギュレーションパラメータ名
var コンフィギュレーションパラメータ格納用変数
def_val コンフィギュレーションパラメータデフォルト値
trans コンフィギュレーションパラメータ文字列変換用関数
戻り値:
設定結果(設定成功:true,設定失敗:false)

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

コンフィギュレーションパラメータの更新(ID指定)

指定したIDのコンフィギュレーションセットに設定した値で、 コンフィギュレーションパラメータの値を更新する 指定したIDのコンフィギュレーションセットが存在しない場合は、 何もせずに終了する。

引数:
config_set 設定対象のコンフィギュレーションセットID

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

コンフィギュレーションパラメータの更新(名称指定)

指定したパスのコンフィギュレーションに設定した値で、 コンフィギュレーションパラメータの値を更新する

引数:
config_set コンフィギュレーション名称。「.」区切りで最後の要素を 除いた名前
config_param コンフィギュレーションセットの最後の要素名

void RTC::ConfigAdmin::update ( void   ) 

コンフィギュレーションパラメータの更新 (アクティブコンフィギュレーションセット)

コンフィギュレーションセットが更新されている場合に、 現在アクティブになっているコンフィギュレーションに設定した値で、 コンフィギュレーションパラメータの値を更新する。 この処理での更新は、アクティブとなっているコンフィギュレーションセットが 存在している場合、前回の更新からコンフィギュレーションセットの内容が 更新されている場合のみ実行される。

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

コンフィギュレーションパラメータの存在確認

指定した名称を持つコンフィギュレーションパラメータが存在するか確認する。

引数:
name コンフィギュレーションパラメータ名称。
戻り値:
存在確認結果(パラメータあり:true,パラメータなし:false)

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

コンフィギュレーションパラメータの変更確認

コンフィギュレーションパラメータが変更されたか確認する。

戻り値:
変更確認結果(変更あり:true、変更なし:false)

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

アクティブ・コンフィギュレーションセットIDの取得

現在アクティブなコンフィギュレーションセットのIDを取得する。

戻り値:
アクティブ・コンフィギュレーションセットID

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

コンフィギュレーションセットの存在確認

指定したコンフィギュレーションセットが存在するか確認する。

引数:
config_id 確認対象コンフィギュレーションセットID
戻り値:
存在確認結果(指定したConfigSetあり:true、なし:false)

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

コンフィギュレーションセットのアクティブ化確認

コンフィギュレーションセットがアクティブ化されているか確認する。

戻り値:
状態確認結果(アクティブ状態:true、非アクティブ状態:false)

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

全コンフィギュレーションセットの取得

設定されている全コンフィギュレーションセットを取得する。

戻り値:
全コンフィギュレーションセット

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

指定したIDのコンフィギュレーションセットの取得

IDで指定したコンフィギュレーションセットを取得する。 指定したコンフィギュレーションセットが存在しない場合は、 空のコンフィギュレーションセットを返す。

引数:
config_id 取得対象コンフィギュレーションセットのID
戻り値:
コンフィギュレーションセット

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

指定したプロパティのコンフィギュレーションセットへの追加

指定したプロパティをIDで指定したコンフィギュレーションセットへ追加する。 指定したIDと一致するコンフィギュレーションセットが存在しない場合は、 false を返す。

引数:
config_id 追加対象コンフィギュレーションセットのID
configuration_set 追加するプロパティ
戻り値:
追加処理実行結果(追加成功:true、追加失敗:false)

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

アクティブ・コンフィギュレーションセットを取得

現在アクティブとなっているコンフィギュレーションセットを取得する。 アクティブとなっているコンフィギュレーションセットが存在しない場合は、 空のコンフィギュレーションセット を返す。

戻り値:
アクティブ・コンフィギュレーションセット

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

コンフィギュレーションセットに設定値を追加

コンフィギュレーションセットに設定値を追加する。

引数:
configuration_set 追加するプロパティ
戻り値:
追加処理結果(追加成功:true、追加失敗:false)

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

コンフィギュレーションセットの削除

指定したIDのコンフィギュレーションセットを削除する。 指定したIDのコンフィギュレーションセットが存在しない場合は、 falseを返す。

引数:
config_id 削除対象コンフィギュレーションセットのID
戻り値:
削除処理結果(削除成功:true、削除失敗:false)

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

コンフィギュレーションセットのアクティブ化

指定したIDのコンフィギュレーションセットをアクティブ化する。 指定したIDのコンフィギュレーションセットが存在しない場合は、 falseを返す。

引数:
config_id 削除対象コンフィギュレーションセットのID
戻り値:
アクティブ処理結果(成功:true、失敗:false)

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

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

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

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

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

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

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

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

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

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

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

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


OpenRTMに対してSun May 24 14:08:26 2009に生成されました。  doxygen 1.5.3