jp.go.aist.rtm.RTC
クラス ConfigAdmin

java.lang.Object
  jp.go.aist.rtm.RTC.ConfigAdmin

public class ConfigAdmin
extends java.lang.Object

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

用語を以下のように定義する。

• コンフィギュレーション: コンポーネントの設定情報。
• (コンフィギュレーション)パラメータ： key-value からなる設定情報。 util.Properties 変数として扱われ、key、value 共に文字列として保 持される。key をコンフィギュレーションパラメータ名、value をコン フィギュレーションパラメータ値と呼ぶ。
• コンフィギュレーションセット： コンフィギュレーションパラメータ のリストで、名前 (ID) によって区別される。IDをコンフィギュレーショ ンセットIDと呼ぶ。
• (コンフィギュレーション)パラメータ変数：コンフィギュレーションパ ラメータをRTCのアクティビティ内で実際に利用する際に参照される変 数。パラメータごとに固有の型を持つ。
• アクティブ(コンフィギュレーション)セット：現在有効なコンフィギュ レーションセットのことであり、唯一つ存在する。原則として、アクティ ブコンフィギュレーションセットのパラメータがコンフィギュレーショ ンパラメータ変数に反映される。

このクラスでは、コンフィギュレーションのための以下の2つの情報を保 持している。

• # コンフィギュレーションセットのリスト
• # パラメータ変数のリスト

基本的には、(1) のコンフィギュレーションセットのリストのうち一つを、 (2) のパラメータ変数へ反映させる、のが本クラスの目的である。通常、 パラメータ変数の変更操作は、コンフィギュレーションセットの変更とパ ラメータ変数への反映の2段階で行われる。 コンフィギュレーションセットのリストの操作には、以下の関数を用いる。

• getConfigurationSets()
• getConfigurationSet()
• setConfigurationSetValues()
• getActiveConfigurationSet()
• addConfigurationSet()
• removeConfigurationSet()
• activateConfigurationSet()

これらの関数により、コンフィギュレーションセットの変更、追加、削除、 取得、アクティブ化を行う。これらの操作により変更されたコンフィギュ レーションセットを、RTCのアクティビティから使用するパラメータ変数 に反映させるには、以下の update() 関数を用いる。

• update(void)
• update(const char* config_set)
• update(const char* config_set, const char* config_param)

コンフィギュレーション操作をフックするためにコールバックファンクタ を与えることができる。フックできる操作は以下の通り。

• ON_UPDATE : update() コール時
• ON_UPDATE_PARAM : update(param) コール時
• ON_SET_CONFIGURATIONSET : setConfigurationSet() コール時
• ON_ADD_CONFIGURATIONSET : addConfigurationSet() コール時
• ON_REMOVE_CONFIGURATIONSET : removeConfigurationSet() コール時
• ON_ACTIVATE_CONFIGURATIONSET: activateConfigurationSet() コール時

入れ子のクラスの概要

(package private) class	ConfigAdmin.OnActivateSetCallback OnActivateSetCallbackクラス
(package private) class	ConfigAdmin.OnAddConfigurationAddCallback OnAddConfigurationAddCallbackクラス
(package private) class	ConfigAdmin.OnRemoveConfigurationSetCallback OnRemoveConfigurationSetCallbackクラス
(package private) class	ConfigAdmin.OnSetConfigurationSetCallback OnSetConfigurationSetCallbackクラス
(package private) class	ConfigAdmin.OnUpdateCallback OnUpdateCallbackクラス
(package private) class	ConfigAdmin.OnUpdateParamCallback OnUpdateParamCallbackクラス

コンストラクタの概要

ConfigAdmin(Properties configsets)
コンストラクタ

メソッドの概要

boolean	activateConfigurationSet(java.lang.String config_id) コンフィギュレーションセットのアクティブ化。
boolean	addConfigurationSet(Properties config_set) コンフィギュレーションセットに設定値を追加。
boolean	bindParameter(java.lang.String param_name, ValueHolder var, java.lang.String def_val) コンフィギュレーションパラメータの設定。
void	destruct() デストラクタ
protected void	finalize() ファイナライザ
Properties	getActiveConfigurationSet() アクティブ・コンフィギュレーションセットを取得。
java.lang.String	getActiveId() アクティブ・コンフィギュレーションセットIDの取得。
Properties	getConfigurationSet(java.lang.String config_id) 指定したIDのコンフィギュレーションセットの取得。
java.util.Vector<Properties>	getConfigurationSets() 全コンフィギュレーションセットの取得。
boolean	haveConfig(java.lang.String config_id) コンフィギュレーションセットの存在確認。
boolean	isActive() コンフィギュレーションセットのアクティブ化確認。
boolean	isChanged() コンフィギュレーションパラメータの変更確認。
boolean	isExist(java.lang.String param_name) コンフィギュレーションパラメータの存在確認。
void	onActivateSet(java.lang.String config_id) セットがアクティブ化されたときにコールされる。
void	onAddConfigurationSet(Properties config_set) 設定値が追加されたときにコールされる。
void	onRemoveConfigurationSet(java.lang.String config_id) セットが削除されてるときにコールされる。
void	onSetConfigurationSet(Properties config_set) コンフィギュレーションセットへの追加時にコールされる。
void	onUpdate(java.lang.String config_set) コンフィギュレーションパラメータの更新(ID指定)時にコールされる。
void	onUpdateParam(java.lang.String config_set, java.lang.String config_param) コンフィギュレーションパラメータの更新(名称指定)時にコールされる。
boolean	removeConfigurationSet(java.lang.String config_id) コンフィギュレーションセットの削除。
boolean	setConfigurationSetValues(java.lang.String config_id, Properties config_set) 指定したプロパティのコンフィギュレーションセットへの追加。
void	setOnActivateSet(OnActivateSetCallbackFunc cb) OnActivateSet のコールバックの設定
void	setOnAddConfigurationSet(OnAddConfigurationAddCallbackFunc cb) OnAddConfigurationSet のコールバックの設定
void	setOnRemoveConfigurationSet(OnRemoveConfigurationSetCallbackFunc cb) OnRemoveConfigurationSet のコールバックの設定
void	setOnSetConfigurationSet(OnSetConfigurationSetCallbackFunc cb) OnSetConfigurationSet のコールバックの設定
void	setOnUpdate(OnUpdateCallbackFunc cb) OnUpdate のコールバックの設定
void	setOnUpdateParam(OnUpdateParamCallbackFunc cb) OnUpdateParam のコールバックの設定
void	update() コンフィギュレーションパラメータの更新 (アクティブコンフィギュレーションセット)。
void	update(java.lang.String config_set) コンフィギュレーションパラメータの更新(ID指定)。
void	update(java.lang.String config_set, java.lang.String config_param) コンフィギュレーションパラメータの更新(名称指定)。

クラス java.lang.Object から継承されたメソッド

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

コンストラクタの詳細

ConfigAdmin

public ConfigAdmin(Properties configsets)

コンストラクタ

パラメータ:

configsets - 設定対象プロパティ

メソッドの詳細

destruct

public void destruct()

デストラクタ

finalize

protected void finalize()
                 throws java.lang.Throwable

ファイナライザ

オーバーライド:

クラス java.lang.Object 内の finalize

例外:

java.lang.Throwable

bindParameter

public boolean bindParameter(java.lang.String param_name,
                             ValueHolder var,
                             java.lang.String def_val)

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

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

パラメータ:

param_name - 設定対象パラメータ名

var - 設定対象値

def_val - デフォルト値

戻り値:

設定結果(設定成功:true，設定失敗:false)

update

public void update(java.lang.String config_set)

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

コンフィギュレーション変数の値を、指定したIDを持つコンフィギュレー ションセットの値で更新する。これにより、アクティブなコンフィギュ レーションセットは変更されない。したがって、アクティブコンフィギュ レーションセットとパラメータ変数の間に矛盾が発生する可能性がある ので注意が必要である。 指定したIDのコンフィギュレーションセットが存在しない場合は、何も せずに終了する。

パラメータ:

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

update

public void update()

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

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

update

public void update(java.lang.String config_set,
                   java.lang.String config_param)

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

特定のコンフィギュレーション変数の値を、指定したIDを持つコンフィ ギュレーションセットの値で更新する。これにより、アクティブなコン フィギュレーションセットは変更されない。したがって、アクティブコ ンフィギュレーションセットとパラメータ変数の間に矛盾が発生する可 能性があるので注意が必要である。 指定したIDのコンフィギュレーションセットや、指定した名称のパラメー タが存在しない場合は、何もせずに終了する。

パラメータ:

config_set - コンフィギュレーションID

config_param - コンフィギュレーションパラメータ名

isExist

public boolean isExist(java.lang.String param_name)

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

指定した名称を持つコンフィギュレーションパラメータ変数が存在する か確認する。ここで存在確認を行うパラメータ変数とは、 bindParameter() によって登録される、変数を持つパラメータである。

パラメータ:

param_name - コンフィギュレーションパラメータ名称。

戻り値:

存在確認結果(パラメータあり:true，パラメータなし:false)

isChanged

public boolean isChanged()

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

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

戻り値:

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

getActiveId

public final java.lang.String getActiveId()

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

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

戻り値:

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

haveConfig

public final boolean haveConfig(java.lang.String config_id)

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

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

パラメータ:

config_id - 確認対象コンフィギュレーションセットID

戻り値:

存在確認結果(指定したConfigSetあり:true、なし:false)

isActive

public boolean isActive()

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

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

戻り値:

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

getConfigurationSets

public final java.util.Vector<Properties> getConfigurationSets()

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

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

戻り値:

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

getConfigurationSet

public final Properties getConfigurationSet(java.lang.String config_id)

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

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

パラメータ:

config_id - 取得対象コンフィギュレーションセットのID

戻り値:

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

setConfigurationSetValues

public boolean setConfigurationSetValues(java.lang.String config_id,
                                         Properties config_set)

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

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

パラメータ:

config_id - 追加対象コンフィギュレーションセットのID

config_set - 追加するプロパティ

戻り値:

追加処理実行結果(追加成功:true、追加失敗:false)

getActiveConfigurationSet

public final Properties getActiveConfigurationSet()

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

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

戻り値:

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

addConfigurationSet

public boolean addConfigurationSet(Properties config_set)

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

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

パラメータ:

config_set - 追加するプロパティ

戻り値:

追加処理結果(追加成功:true、追加失敗:false)

removeConfigurationSet

public boolean removeConfigurationSet(java.lang.String config_id)

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

指定したIDのコンフィギュレーションセットを削除する。 指定したIDのコンフィギュレーションセットが存在しない場合は、 falseを返す。削除可能なコンフィギュレーションセットは、 addConfigruationSet() によって追加したコンフィギュレーションセッ トのみであり、デフォルトコンフィギュレーションセット、コンポーネ ント起動時にファイルから読み込まれるコンフィギュレーションセット は削除することができない。 また、指定したコンフィギュレーションセットが現在アクティブである 場合には、いかなるコンフィギュレーションセットでも削除できない。 この関数により実際にコンフィギュレーションセットが削除された場合、 setOnRemoveConfigurationSet() でセットされたコールバック関数が呼 び出される。

パラメータ:

config_id - 削除対象コンフィギュレーションセットのID

戻り値:

削除処理結果(削除成功:true、削除失敗:false)

activateConfigurationSet

public boolean activateConfigurationSet(java.lang.String config_id)

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

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

パラメータ:

config_id - アクティブにするコンフィギュレーションセットID

戻り値:

アクティブ処理結果(成功:true、失敗:false)

setOnUpdate

public void setOnUpdate(OnUpdateCallbackFunc cb)

OnUpdate のコールバックの設定

OnUpdate で呼ばれるコールバックのオブジェクトを設定する。

パラメータ:

cb - OnUpdateCallback型のオブジェクト

setOnUpdateParam

public void setOnUpdateParam(OnUpdateParamCallbackFunc cb)

OnUpdateParam のコールバックの設定

OnUpdateParam で呼ばれるコールバックのオブジェクトを設定する。

パラメータ:

cb - OnUpdateParamCallback型のオブジェクト

setOnSetConfigurationSet

public void setOnSetConfigurationSet(OnSetConfigurationSetCallbackFunc cb)

OnSetConfigurationSet のコールバックの設定

OnSetConfigurationSet で呼ばれるコールバックのオブジェクトを 設定する。

パラメータ:

cb - OnSetConfigurationSetCallback型のオブジェクト

setOnAddConfigurationSet

public void setOnAddConfigurationSet(OnAddConfigurationAddCallbackFunc cb)

OnAddConfigurationSet のコールバックの設定

OnAddConfigurationSet で呼ばれるコールバックのオブジェクト を設定する。

パラメータ:

cb - OnAddConfigurationAddCallback型のオブジェクト

setOnRemoveConfigurationSet

public void setOnRemoveConfigurationSet(OnRemoveConfigurationSetCallbackFunc cb)

OnRemoveConfigurationSet のコールバックの設定

OnRemoveConfiguration で呼ばれるコールバックのオブジェクトを 設定する。

パラメータ:

cb - OnRemoveConfigurationSetCallback型のオブジェクト

setOnActivateSet

public void setOnActivateSet(OnActivateSetCallbackFunc cb)

OnActivateSet のコールバックの設定

OnActivateSet で呼ばれるコールバックのオブジェクトを設定する。

パラメータ:

cb - OnActivateSetCallback型のオブジェクト

onUpdate

public void onUpdate(java.lang.String config_set)

コンフィギュレーションパラメータの更新(ID指定)時にコールされる。

設定されてるコールバックオブジェクトを呼び出す。

パラメータ:

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

onUpdateParam

public void onUpdateParam(java.lang.String config_set,
                          java.lang.String config_param)

コンフィギュレーションパラメータの更新(名称指定)時にコールされる。

設定されてるコールバックオブジェクトを呼び出す。

パラメータ:

config_set - コンフィギュレーションID

config_param - コンフィギュレーションパラメータ名

onSetConfigurationSet

public void onSetConfigurationSet(Properties config_set)

コンフィギュレーションセットへの追加時にコールされる。

設定されてるコールバックオブジェクトを呼び出す。

パラメータ:

config_set - プロパティ

onAddConfigurationSet

public void onAddConfigurationSet(Properties config_set)

設定値が追加されたときにコールされる。

設定されてるコールバックオブジェクトを呼び出す。

パラメータ:

config_set - プロパティ

onRemoveConfigurationSet

public void onRemoveConfigurationSet(java.lang.String config_id)

セットが削除されてるときにコールされる。

設定されてるコールバックオブジェクトを呼び出す。

パラメータ:

config_id - プロパティ

onActivateSet

public void onActivateSet(java.lang.String config_id)

セットがアクティブ化されたときにコールされる。

設定されてるコールバックオブジェクトを呼び出す。

パラメータ:

config_id - プロパティ