OpenRTM_aist.ManagerConfig.ManagerConfig クラス

[詳解]

公開メンバ関数
	__init__ (self, argv=None)
	init (self, argv)
	configure (self, prop)
	parseArgs (self, argv)
	findConfigFile (self)
	setSystemInformation (self, prop)
	fileExist (self, filename)

静的公開変数類
str	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

構築子と解体子

__init__()

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

コンストラクタ

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

引数

self
argv	コマンドライン引数(デフォルト値:None)

メソッド詳解

configure()

OpenRTM_aist.ManagerConfig.ManagerConfig.configure	(		self,
			prop )

Configuration 情報を Property に設定する

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

引数

self
prop	Configuration 設定対象 Property

fileExist()

OpenRTM_aist.ManagerConfig.ManagerConfig.fileExist	(		self,
			filename )

ファイルの存在確認

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

引数

self
filename	確認対象ファイル名称

戻り値

対象ファイル確認結果(存在する場合にtrue)

findConfigFile()

OpenRTM_aist.ManagerConfig.ManagerConfig.findConfigFile

(

self

)

Configuration file の検索

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

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

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

引数

self

戻り値

Configuration file 検索結果

init()

OpenRTM_aist.ManagerConfig.ManagerConfig.init	(		self,
			argv )

初期化

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

-a : マネージャサービスをOFFにする。
-f file : コンフィギュレーションファイルを指定する。
-l module : ロードするモジュールを指定する。(未実装)
-o options: その他オプションを指定する。
-p : ポート番号を指定する。
-d : マスターマネージャを起動する。

引数

self
argv	コマンドライン引数

parseArgs()

OpenRTM_aist.ManagerConfig.ManagerConfig.parseArgs	(		self,
			argv )

コンフィギュレーションを取得する(未実装)

コンフィギュレーションを取得する。init()呼び出し前に呼ぶと、 静的に定義されたデフォルトのコンフィギュレーションを返す。 init() 呼び出し後に呼ぶと、コマンドライン引数、環境変数等に 基づいた初期化されたコンフィギュレーションを返す。

def getConfig(self): pass

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

-a : マネージャサービスをOFFにする。
-f file : コンフィギュレーションファイルを指定する。
-l module : ロードするモジュールを指定する。(未実装)
-o options: その他オプションを指定する。
-p : ポート番号を指定する。
-d : マスターマネージャを起動する。

引数

self
argv	コマンドライン引数

setSystemInformation()

OpenRTM_aist.ManagerConfig.ManagerConfig.setSystemInformation	(		self,
			prop )

システム情報を設定する

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

• os.name : OS名
• os.release : OSリリース名
• os.version : OSバージョン名
• os.arch : OSアーキテクチャ
• os.hostname: ホスト名
• manager.pid: プロセスID

引数

self
prop	システム情報を設定したプロパティ

メンバ詳解

config_file_env

str OpenRTM_aist.ManagerConfig.ManagerConfig.config_file_env = "RTC_MANAGER_CONFIG"

static

デフォルト・コンフィギュレーションのファイル・パスを識別する 環境変数

---

このクラス詳解は次のファイルから抽出されました:

• ManagerConfig.py