クラス ConfigAdmin

ConfigAdmin クラス [詳細]


Public メソッド

def __init__
 コンストラクタ
def __del__
 デストラクタ
def bindParameter
 コンフィギュレーションパラメータの設定
def update
 コンフィギュレーションパラメータの更新
def isExist
 コンフィギュレーションパラメータの存在確認
def isChanged
 コンフィギュレーションパラメータの変更確認
def getActiveId
 アクティブ・コンフィギュレーションセットIDの取得
def haveConfig
 コンフィギュレーションセットの存在確認
def isActive
 コンフィギュレーションセットのアクティブ化確認
def getConfigurationSets
 全コンフィギュレーションセットの取得
def getConfigurationSet
 指定したIDのコンフィギュレーションセットの取得
def setConfigurationSetValues
 指定したプロパティのコンフィギュレーションセットへの追加
def getActiveConfigurationSet
 アクティブ・コンフィギュレーションセットを取得
def addConfigurationSet
 コンフィギュレーションセットに設定値を追加
def removeConfigurationSet
 コンフィギュレーションセットの削除
def activateConfigurationSet
 コンフィギュレーションセットのアクティブ化


説明

ConfigAdmin クラス

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

から:
0.4.0

ConfigAdmin.py163 行で定義されています。


関数

def __init__ (   self,
  configsets 
)

コンストラクタ

コンストラクタ

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

ConfigAdmin.py182 行で定義されています。

def __del__ (   self  ) 

デストラクタ

デストラクタ。 設定されているパラメータを削除する。

引数:
self 

ConfigAdmin.py205 行で定義されています。

def bindParameter (   self,
  param_name,
  var,
  def_val,
  trans = None 
)

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

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

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

ConfigAdmin.py230 行で定義されています。

def update (   self,
  config_set = None,
  config_param = None 
)

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

引数の設定状況によって以下の処理を行う。

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

ConfigAdmin.py274 行で定義されています。

def isExist (   self,
  param_name 
)

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

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

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

ConfigAdmin.py316 行で定義されています。

def isChanged (   self  ) 

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

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

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

ConfigAdmin.py341 行で定義されています。

def getActiveId (   self  ) 

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

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

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

ConfigAdmin.py359 行で定義されています。

def haveConfig (   self,
  config_id 
)

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

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

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

ConfigAdmin.py378 行で定義されています。

def isActive (   self  ) 

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

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

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

ConfigAdmin.py399 行で定義されています。

def getConfigurationSets (   self  ) 

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

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

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

ConfigAdmin.py417 行で定義されています。

def getConfigurationSet (   self,
  config_id 
)

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

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

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

ConfigAdmin.py438 行で定義されています。

def setConfigurationSetValues (   self,
  config_id,
  config_set 
)

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

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

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

ConfigAdmin.py463 行で定義されています。

def getActiveConfigurationSet (   self  ) 

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

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

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

ConfigAdmin.py495 行で定義されています。

def addConfigurationSet (   self,
  configset 
)

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

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

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

ConfigAdmin.py518 行で定義されています。

def removeConfigurationSet (   self,
  config_id 
)

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

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

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

ConfigAdmin.py553 行で定義されています。

def activateConfigurationSet (   self,
  config_id 
)

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

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

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

ConfigAdmin.py593 行で定義されています。


OpenRTMに対してMon Mar 17 15:11:07 2008に生成されました。  doxygen 1.5.4