クラス RTC::ManagerConfig

Manager configuration クラス. [詳細]

#include <ManagerConfig.h>

すべてのメンバ一覧

Public メソッド

 ManagerConfig ()
 コンストラクタ
 ManagerConfig (int argc, char **argv)
 コンストラクタ
virtual ~ManagerConfig (void)
 デストラクタ
void init (int argc, char **argv)
 初期化
void configure (coil::Properties &prop)
 Configuration 情報を Property に設定する.
coil::Properties getConfig () const
 コンフィギュレーションを取得する

Static Public 変数

static const char * config_file_path []
 Manager コンフィギュレーションのデフォルト・ファイル・パス.
static const char * config_file_env
 デフォルト・コンフィギュレーションのファイル・パスを識別する 環境変数

Protected メソッド

void parseArgs (int argc, char **argv)
 コマンド引数をパースする
bool findConfigFile ()
 Configuration file の検索.
void setSystemInformation (coil::Properties &prop)
 システム情報を設定する
bool fileExist (const std::string &filename)
 ファイルの存在確認

Protected 変数

coil::Properties m_argprop
 引数から渡されるプロパティ
std::string m_configFile
 Manager コンフィギュレーション・ファイルのパス.
bool m_isMaster
 Manager マスタフラグ.

説明

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

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

RTC::ManagerConfig::ManagerConfig (  ) 

コンストラクタ

コンストラクタ。(何もしない)

RTC::ManagerConfig::ManagerConfig ( int  argc,
char **  argv 
)

コンストラクタ

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

引数:
argc コマンドライン引数の数
argv コマンドライン引数
virtual RTC::ManagerConfig::~ManagerConfig ( void   )  [virtual]

デストラクタ


関数

void RTC::ManagerConfig::configure ( coil::Properties prop  ) 

Configuration 情報を Property に設定する.

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

引数:
prop Configuration 設定対象 Property
bool RTC::ManagerConfig::fileExist ( const std::string &  filename  )  [protected]

ファイルの存在確認

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

引数:
filename 確認対象ファイル名称
戻り値:
対象ファイル確認結果(存在する場合にtrue)
bool RTC::ManagerConfig::findConfigFile (  )  [protected]

Configuration file の検索.

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

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

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

戻り値:
Configuration file 検索結果
coil::Properties RTC::ManagerConfig::getConfig (  )  const

コンフィギュレーションを取得する

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

戻り値:
Manager のコンフィギュレーション情報
void RTC::ManagerConfig::init ( int  argc,
char **  argv 
)

初期化

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

  • -f file : コンフィギュレーションファイルを指定する。
  • -l module : ロードするモジュールを指定する。(未実装)
  • -o options: その他オプションを指定する。(未実装)
  • -d : デフォルトのコンフィギュレーションを使う。(未実装)
引数:
argc コマンドライン引数の数
argv コマンドライン引数
void RTC::ManagerConfig::parseArgs ( int  argc,
char **  argv 
) [protected]

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

  • -f file : コンフィギュレーションファイルを指定する。
  • -l module : ロードするモジュールを指定する。(未実装)
  • -o options: その他オプションを指定する。(未実装)
  • -d : デフォルトのコンフィギュレーションを使う。(未実装)
引数:
argc コマンドライン引数の数
argv コマンドライン引数
void RTC::ManagerConfig::setSystemInformation ( coil::Properties prop  )  [protected]

システム情報を設定する

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

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

変数

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

const char* RTC::ManagerConfig::config_file_path[] [static]

Manager コンフィギュレーションのデフォルト・ファイル・パス.

引数から渡されるプロパティ

std::string RTC::ManagerConfig::m_configFile [protected]

Manager コンフィギュレーション・ファイルのパス.

Manager マスタフラグ.

true:マスタ,false:スレーブ

OpenRTM-aistに対してFri Oct 28 18:31:16 2016に生成されました。  doxygen 1.6.3