クラス OpenRTM_aist.ManagerConfig.ManagerConfig

Manager configuration クラス. [詳細]

すべてのメンバ一覧

Public メソッド

def __init__
 コンストラクタ
def init
 初期化
def configure
 Configuration 情報を Property に設定する.
def parseArgs
 コマンド引数をパースする
def findConfigFile
 Configuration file の検索.
def setSystemInformation
 システム情報を設定する
def fileExist
 ファイルの存在確認

Static Public 変数

list config_file_path
 Manager コンフィギュレーションのデフォルト・ファイル・パス.
string config_file_env = "RTC_MANAGER_CONFIG"
 デフォルト・コンフィギュレーションのファイル・パスを識別する 環境変数

説明

Manager configuration クラス.

Manager のコンフィギュレーションを行う、コマンドライン引数を受け取り、 (あるいは引数なしで)インスタンス化される。 コマンドライン引数で指定された設定ファイル、環境変数などから Manager の プロパティ情報を設定する。

各設定の優先度は以下のとおりである。

  1. コマンドラインオプション "-f"
  2. 環境変数 "RTC_MANAGER_CONFIG"
  3. デフォルト設定ファイル "./rtc.conf"
  4. デフォルト設定ファイル "/etc/rtc.conf"
  5. デフォルト設定ファイル "/etc/rtc/rtc.conf"
  6. デフォルト設定ファイル "/usr/local/etc/rtc.conf"
  7. デフォルト設定ファイル "/usr/local/etc/rtc/rtc.conf"
  8. 埋め込みコンフィギュレーション値

ただし、コマンドラインオプション "-d" が指定された場合は、 (たとえ -f で設定ファイルを指定しても)埋め込みコンフィギュレーション値 が使用される。

から:
0.4.0

メソッド

def OpenRTM_aist.ManagerConfig.ManagerConfig.__init__ (   self,
  argv = None 
)

コンストラクタ

与えられた引数によりコンフィギュレーション情報の初期化を行う。

引数:
self 
argv コマンドライン引数(デフォルト値:None)
def OpenRTM_aist.ManagerConfig.ManagerConfig.configure (   self,
  prop 
)

Configuration 情報を Property に設定する.

Manager のConfiguration 情報を指定された Property に設定する。

引数:
self 
prop Configuration 設定対象 Property
def OpenRTM_aist.ManagerConfig.ManagerConfig.fileExist (   self,
  filename 
)

ファイルの存在確認

指定されたファイルが存在するか確認する。

引数:
self 
filename 確認対象ファイル名称
戻り値:
対象ファイル確認結果(存在する場合にtrue)
def OpenRTM_aist.ManagerConfig.ManagerConfig.findConfigFile (   self  ) 

Configuration file の検索.

Configuration file を検索し、設定する。 既に Configuration file が設定済みの場合は、ファイルの存在確認を行う。

Configuration file の優先順位
コマンドオプション指定>環境変数>デフォルトファイル>デフォルト設定

デフォルト強制オプション(-d): デフォルトファイルがあっても無視して デフォルト設定を使う

引数:
self 
戻り値:
Configuration file 検索結果
def OpenRTM_aist.ManagerConfig.ManagerConfig.init (   self,
  argv 
)

初期化

コマンドライン引数に応じて初期化を実行する。コマンドラインオプションは 以下のものが使用可能である。

-f file : コンフィギュレーションファイルを指定する。
-l module : ロードするモジュールを指定する。(未実装)
-o options: その他オプションを指定する。(未実装)
-d : デフォルトのコンフィギュレーションを使う。(未実装)

引数:
self 
argv コマンドライン引数
def OpenRTM_aist.ManagerConfig.ManagerConfig.parseArgs (   self,
  argv 
)

コマンド引数をパースする

-f file : コンフィギュレーションファイルを指定する。
-l module : ロードするモジュールを指定する。(未実装)
-o options: その他オプションを指定する。(未実装)
-d : デフォルトのコンフィギュレーションを使う。(未実装)

引数:
self 
argv コマンドライン引数
def OpenRTM_aist.ManagerConfig.ManagerConfig.setSystemInformation (   self,
  prop 
)

システム情報を設定する

システム情報を取得しプロパティにセットする。設定されるキーは以下の通り。

  • manager.os.name : OS名
  • manager.os.release : OSリリース名
  • manager.os.version : OSバージョン名
  • manager.os.arch : OSアーキテクチャ
  • manager.os.hostname: ホスト名
  • manager.pid : プロセスID
引数:
self 
prop システム情報を設定したプロパティ

このクラスの説明は次のファイルから生成されました:
OpenRTM-aist-1.0.0-Pythonに対してThu Mar 10 16:01:42 2011に生成されました。  doxygen 1.6.3