OpenRTM-aist  1.2.1
公開メンバ関数 | 静的公開変数類 | 限定公開メンバ関数 | 限定公開変数類 | 全メンバ一覧
RTC::ManagerConfig クラス

Manager configuration クラス [詳解]

#include <ManagerConfig.h>

RTC::ManagerConfig 連携図
Collaboration graph
[凡例]

公開メンバ関数

 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 const char * config_file_path []
 Manager コンフィギュレーションのデフォルト・ファイル・パス [詳解]
 
static const char * config_file_env
 デフォルト・コンフィギュレーションのファイル・パスを識別する 環境変数 [詳解]
 

限定公開メンバ関数

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

限定公開変数類

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

詳解

Manager configuration クラス

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

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

から
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 に設定する。

引数
propConfiguration 設定対象 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 
)

初期化

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

  • -a : マネージャサービスOFF
  • -f <file name>=""> : 設定ファイルの指定
  • -o <option> ; オプション指定
  • -p <port number>="">: ポート番号指定
  • -d : マスターマネージャ指定
引数
argcコマンドライン引数の数
argvコマンドライン引数
void RTC::ManagerConfig::parseArgs ( int  argc,
char **  argv 
)
protected

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

  • -a : マネージャサービスOFF
  • -f <file name>=""> : 設定ファイルの指定
  • -o <option> ; オプション指定
  • -p <port number>="">: ポート番号指定
  • -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_env
static

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

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

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

coil::Properties RTC::ManagerConfig::m_argprop
protected

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

std::string RTC::ManagerConfig::m_configFile
protected

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

bool RTC::ManagerConfig::m_isMaster
protected

Manager マスタフラグ

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

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