[openrtm-commit:02833] r1049 - trunk/OpenRTM-aist-Java/jp.go.aist.rtm.RTC/idl
openrtm ＠ openrtm.org
openrtm ＠ openrtm.org
2017年 9月 15日 (金) 16:54:45 JST
Author: t-katami
Date: 2017-09-15 16:54:45 +0900 (Fri, 15 Sep 2017)
New Revision: 1049
Modified:
trunk/OpenRTM-aist-Java/jp.go.aist.rtm.RTC/idl/Manager.idl
Log:
[compat->RELENG_1_2] Update Manager.idl.
Modified: trunk/OpenRTM-aist-Java/jp.go.aist.rtm.RTC/idl/Manager.idl
===================================================================
--- trunk/OpenRTM-aist-Java/jp.go.aist.rtm.RTC/idl/Manager.idl 2017-09-15 07:07:39 UTC (rev 1048)
+++ trunk/OpenRTM-aist-Java/jp.go.aist.rtm.RTC/idl/Manager.idl 2017-09-15 07:54:45 UTC (rev 1049)
@@ -5,9 +5,7 @@
* @date $Date: 2005-05-12 09:06:18 $
* @author Noriaki Ando <n-ando at aist.go.jp>
*
- * Copyright (C) 2003-2005
- * Task-intelligence Research Group,
- * Intelligent Systems Research Institute,
+ * Copyright (C) 2003-2017
* National Institute of
* Advanced Industrial Science and Technology (AIST), Japan
* All rights reserved.
@@ -45,25 +43,96 @@
interface Manager;
typedef sequence<Manager> ManagerList;
+ /*!
+ * @if jp
+ * @interface Manager
+ *
+ * RTコンポーネントのライフサイクルの管理などを行うManagerへの外部イ
+ * ンターフェース。主たる機能としては、以下のものがある。
+ *
+ * - RTCのローダブルモジュールの操作
+ * - モジュールのロード
+ * - モジュールのアンロード
+ * - ロード可能なモジュール一覧の取得
+ * - ロード済みモジュール一覧の取得
+ * - ロード済みモジュールのプロファイル一覧の取得
+ * - RTCに関する操作
+ * - コンポーネントの生成
+ * - コンポーネントの削除
+ * - インスタンス化済みのRTC一覧の取得
+ * - インスタンス化済みのRTCのプロファイル一覧の取得
+ * - 名前によるコンポーネントの取得
+ * - マネージャに関する操作
+ * - マネージャのプロファイル情報の取得
+ * - マネージャのコンフィギュレーション情報の取得
+ * - マネージャのコンフィギュレーション情報の設定
+ * - マネージャがマスターかどうか
+ * - マスターマネージャの取得
+ * - マスターマネージャの追加
+ * - マスターマネージャの削除
+ * - スレーブマネージャの取得
+ * - スレーブマネージャの追加
+ * - スレーブマネージャの削除
+ * - サービスの取得
+ * - プロセス操作
+ * - フォーク
+ * - シャットダウン
+ * - リスタート
+ *
+ * マネージャには、同一ノード内で原則1つしか存在しないマスターマネー
+ * ジャと、マスターマネージャの管理下に0個以上存在するスレーブマネー
+ * ジャが存在する。
+ *
+ * マスターマネージャは通常、デーモン・サービスなどとして常駐し、ノー
+ * ドのOS稼働中は原則として常に動作し続ける。また、マスターマネージャ
+ * は自身の内部にRTCを生成・ホストせず、RTCの生成はスレーブマネージャ
+ * に依頼する。依頼するスレーブマネージャは、すでに起動しているもので
+ * も、マスターマネージャが新規に起動してもよい。どちらの方法でRTCを
+ * 生成するかは、create_component() の引数にて指定する。なお、スレー
+ * ブマネージャは通常、1つ以上のRTCをホストする。デフォルトの設定では、
+ * RTCをホストしていないスレーブマネージャは自動終了する。
+ * 設定項目：
+ * - manager.shutdown_on_nortcs: YES
+ * - manager.shutdown_auto: YES
+ *
+ * <pre>
+ * 1 0..* 1 1..*
+ * [ master ]<>----------[ slave ]<>----------[ RTC ]
+ *
+ * </pre>
+ *
+ * @else
+ * @interface
+ *
+ * @endif
+ */
interface Manager
{
- // module ´ØÏ¢
+ // module 関連
/*!
* @if jp
- * @brief ¥â¥¸¥å¡¼¥ë¤ò¥í¡¼¥É¤¹¤ë
+ * @brief モジュールをロードする
*
- * Åö³º¥Þ¥Í¡¼¥¸¥ã¤Ë»ØÄꤵ¤ì¤¿¥â¥¸¥å¡¼¥ë¤ò¥í¡¼¥É¤·¡¢»ØÄꤵ¤ì¤¿½é´ü²½
- * ´Ø¿ô¤Ç½é´ü²½¤ò¹Ô¤¦¡£
+ * 当該マネージャに指定されたモジュールをロードし、指定された初期化
+ * 関数で初期化を行う。任意の共有オブジェクトファイル (.so, .dll)
+ * をロード可能であり、コンポーネントの共有オブジェクトファイルに限
+ * らない。通常、RTCの生成時は自動的にロードパス上を共有オブジェク
+ * トファイルを探索するため、この操作を呼び出す必要はない。
*
- * @param pathname ¥â¥¸¥å¡¼¥ë¤Ø¤Î¥Ñ¥¹
- * @param initfunc ¥â¥¸¥å¡¼¥ë¤Î½é´ü²½´Ø¿ô
- * @return ¥ê¥¿¡¼¥ó¥³¡¼¥É
+ * @param pathname モジュールへのパス
+ * @param initfunc モジュールの初期化関数
+ * @return リターンコード
*
* @else
* @brief Loading a module
*
- * This operation loads a specified loadable module¡¢and perform
- * initialization with the specified function.
+ * This operation loads a specified loadable module、and perform
+ * initialization with the specified function. Any kind of shared
+ * objects (.so, .dll) not only RT-Component's shared object can
+ * be loadable. Usually, you do not need to call this operation to
+ * create RT-Components, because RTC creation operation
+ * automatically search RTC's loadable module in the specified
+ * load path.
*
* @param pathname A path to a loading module.
* @param initfunc Module initialization function.
@@ -75,17 +144,29 @@
/*!
* @if jp
- * @brief ¥â¥¸¥å¡¼¥ë¤ò¥¢¥ó¥í¡¼¥É¤¹¤ë
+ * @brief モジュールをアンロードする
*
- * Åö³º¥Þ¥Í¡¼¥¸¥ã¤Ë»ØÄꤵ¤ì¤¿¥â¥¸¥å¡¼¥ë¤ò¥¢¥ó¥í¡¼¥É¤¹¤ë¡£
+ * 当該マネージャに指定されたモジュールをアンロードする。現在のとこ
+ * ろ、OpenRTM-aistのモジュールロード機能は、ロードされたモジュール
+ * により生成されたオブジェクトのリファレンスカウント管理等は行われ
+ * ていないので、安易にモジュールをアンロードすると、メモリアクセス
+ * 違反を引き起こす恐れがある。ただ、多くの動的ライブラリのアンロー
+ * ドの実装では、実際にメモリ上からアンロードされないケースが多く、
+ * したがってこのオペレーションは呼び出すことを推奨しない。
*
- * @param pathname ¥â¥¸¥å¡¼¥ë¤Ø¤Î¥Ñ¥¹
- * @return ¥ê¥¿¡¼¥ó¥³¡¼¥É
+ * @param pathname モジュールへのパス
+ * @return リターンコード
*
* @else
* @brief Unloading a module
*
- * This operation unloads a specified loadable module.
+ * This operation unloads a specified loadable module. Currently
+ * since OpenRTM-aist's module load function does not manage
+ * object reference count which is created from the loaded shared
+ * object, unloading might cause segmentation fault. However, most
+ * of unload function implementation actually does not unload
+ * shared object from memory space, and it is not recommended to
+ * call this operation in actual use.
*
* @param pathname A path to a loading module.
* @return The return code.
@@ -96,19 +177,114 @@
/*!
* @if jp
- * @brief ¥í¡¼¥É²Äǽ¤Ê¥â¥¸¥å¡¼¥ë¤Î¥×¥í¥Õ¥¡¥¤¥ë¤ò¼èÆÀ¤¹¤ë
+ * @brief ロード可能なモジュールのプロファイルを取得する
*
- * ¥í¡¼¥É²Äǽ¤Ê¥â¥¸¥å¡¼¥ë¤Î¥×¥í¥Õ¥¡¥¤¥ë¤ò¼èÆÀ¤¹¤ë¡£
+ * ロード可能なモジュールのプロファイルを取得する。ロード可能なRTコ
+ * ンポーネントのモジュールのプロファイルは、あらかじめ設定されたモ
+ * ジュールロードパスに対して、プロファイル取得コマンドを別プロセス
+ * で実行することで取得する。プロファイル取得対象となる言語の種類は、
*
- * @return ¥â¥¸¥å¡¼¥ë¥×¥í¥Õ¥¡¥¤¥ë
+ * - manager.supported_language: C++, Python, Java
*
+ * で設定されている。ここで指定された言語に対して、以下のプロパティ
+ * で言語毎のモジュールロードパス、プロファイル取得コマンド、モジュー
+ * ル拡張子が指定される。
+ *
+ * - manager.modules.<言語>.load_paths: ./ (モジュールロードパス)
+ * - manager.modules.<言語>.profile_cmd: rtcprof等コマンド名
+ * - manager.modules.<言語>.suffixes: モジュール拡張子
+ *
+ * 例えば、C++ 言語の場合は、以下のプロパティがデフォルトで設定されている。
+ *
+ * - manager.modules.C++.load_paths: ./ (モジュールロードパス)
+ * - manager.modules.C++.profile_cmd: rtcprof
+ * - manager.modules.C++.suffixes: so (Linuxの場合), dll (Windowsの場合)
+ *
+ * マスターマネージャは、上記で設定されたすべての言語 (Windowsでは
+ * すべてのVCのバージョンも含む) のモジュールロードパスがあらかじめ
+ * 設定されている必要がある。 この作業は、このオペレーションが呼び
+ * 出されたマネージャ (通常はマスターマネージャ) 上でのみ実行され、
+ * 配下にあるスレーブマネージャ等に再帰的に呼び出されることはない。
+ *
+ * @return モジュールプロファイル。なお、モジュールプロファイルは以
+ * 下のような内容を持つKey-Value形式のリストで返される。
+ * <pre>
+ * implementation_id: ConfigSample
+ * type_name: ConfigSample
+ * description: Configuration example component
+ * version: 1.0
+ * vendor: Noriaki Ando, AIST
+ * category: example
+ * activity_type: DataFlowComponent
+ * max_instance: 10
+ * language: C++
+ * lang_type: compile
+ * conf.default.int_param0: 0
+ * conf.default.int_param1: 1
+ * conf.default.double_param0: 0.11
+ * conf.default.double_param1: 9.9
+ * conf.default.str_param0: hoge
+ * conf.default.str_param1: dara
+ * conf.default.vector_param0: 0.0,1.0,2.0,3.0,4.0
+ * </pre>
+ *
* @else
* @brief Getting loadable module profiles
*
- * This operation returns loadable module profiles.
+ * This operation returns loadable module profiles. Loadable
+ * profiles of RT-Components can be obtained by executing profile
+ * obtain commands (ex. rtcprof) into the module load paths that
+ * is specified in the properties. The target kinds of language to
+ * be obtained component profiles are specified the following
+ * property.
*
- * @return A module profile list.
+ * - manager.supported_language: C++, Python, Java
*
+ * For each those languages, module load paths, profile obtain
+ * command and module suffixes are specified in following
+ * properties.
+ *
+ * - manager.modules.<lang>.load_paths: ./ (load paths)
+ * - manager.modules.<lang>.profile_cmd: rtcprof command name
+ * - manager.modules.<lang>.suffixes: module extentions
+ *
+ * For example, the following properties are specified in default
+ * for C++ language.
+ *
+ * - manager.modules.C++.load_paths: ./ (module load pathds)
+ * - manager.modules.C++.profile_cmd: rtcprof
+ * - manager.modules.C++.suffixes: so (for Linux), dll (for Windows)
+ *
+ * The master manager need to be configured module load paths for
+ * all languages (and for all versions of VC in case of Windows)
+ * specified above. This process is performed in only a manager
+ * (master manager in general) in which this operation is called,
+ * and it is not recursively called to slave managers which are
+ * managed by this manager.
+ *
+ * @return A module profile list. The module profiles list
+ * includes zero or more the following Key-Value format
+ * RTC profile.
+ * <pre>
+ * implementation_id: ConfigSample
+ * type_name: ConfigSample
+ * description: Configuration example component
+ * version: 1.0
+ * vendor: Noriaki Ando, AIST
+ * category: example
+ * activity_type: DataFlowComponent
+ * max_instance: 10
+ * language: C++
+ * lang_type: compile
+ * conf.default.int_param0: 0
+ * conf.default.int_param1: 1
+ * conf.default.double_param0: 0.11
+ * conf.default.double_param1: 9.9
+ * conf.default.str_param0: hoge
+ * conf.default.str_param1: dara
+ * conf.default.vector_param0: 0.0,1.0,2.0,3.0,4.0
+ * </pre>
+ *
* @endig
*/
ModuleProfileList get_loadable_modules();
@@ -115,11 +291,14 @@
/*!
* @if jp
- * @brief ¥í¡¼¥ÉºÑ¤ß¤Î¥â¥¸¥å¡¼¥ë¤Î¥×¥í¥Õ¥¡¥¤¥ë¤ò¼èÆÀ¤¹¤ë
+ * @brief ロード済みのモジュールのプロファイルを取得する
*
- * ¥í¡¼¥ÉºÑ¤ß¤Î¥â¥¸¥å¡¼¥ë¤Î¥×¥í¥Õ¥¡¥¤¥ë¤ò¼èÆÀ¤¹¤ë¡£
+ * ロード済みのモジュールのプロファイルを取得する。このオペレーショ
+ * ンでは、スレーブマネージャに対しても同じオペレーションが再帰的に
+ * 呼び出され、配下にあるすべてのマネージャがロードしているすべての
+ * モジュールのプロファイルを返す。
*
- * @return ¥â¥¸¥å¡¼¥ë¥×¥í¥Õ¥¡¥¤¥ë
+ * @return モジュールプロファイル
*
* @else
* @brief Getting loaded module profiles
@@ -132,15 +311,18 @@
*/
ModuleProfileList get_loaded_modules();
- // component ´ØÏ¢
+ // component 関連
/*!
* @if jp
- * @brief ¥³¥ó¥Ý¡¼¥Í¥ó¥È¥Õ¥¡¥¯¥È¥ê¤Î¥×¥í¥Õ¥¡¥¤¥ë¤ò¼èÆÀ¤¹¤ë
+ * @brief コンポーネントファクトリのプロファイルを取得する
*
- * ¥í¡¼¥ÉºÑ¤ß¤Î¥â¥¸¥å¡¼¥ë¤Î¤¦¤Á¡¢RT¥³¥ó¥Ý¡¼¥Í¥ó¥È¤Î¥â¥¸¥å¡¼¥ë¤¬»ý¤Ä
- * ¥Õ¥¡¥¯¥È¥ê¤Î¥×¥í¥Õ¥¡¥¤¥ë¤Î¥ê¥¹¥È¤ò¼èÆÀ¤¹¤ë¡£
+ * ロード済みのモジュールのうち、RTコンポーネントのモジュールが持つ
+ * ファクトリのプロファイルのリストを取得する。このオペレーションで
+ * は、スレーブマネージャに対しても同じオペレーションが再帰的に呼び
+ * 出され、配下にあるすべてのマネージャが保有するRTコンポーネントの
+ * プロファイルを返す。
*
- * @return ¥³¥ó¥Ý¡¼¥Í¥ó¥È¥Õ¥¡¥¯¥È¥ê¤Î¥×¥í¥Õ¥¡¥¤¥ë¥ê¥¹¥È
+ * @return コンポーネントファクトリのプロファイルリスト
*
* @else
* @brief Getting component factory profiles
@@ -156,12 +338,79 @@
/*!
* @if jp
- * @brief ¥³¥ó¥Ý¡¼¥Í¥ó¥È¤òÀ¸À®¤¹¤ë
+ * @brief コンポーネントを生成する
*
- * °ú¿ô¤Ë»ØÄꤵ¤ì¤¿¥³¥ó¥Ý¡¼¥Í¥ó¥È¤òÀ¸À®¤¹¤ë¡£
+ * 引数に指定されたコンポーネントを生成する。マスターマネージャに対
+ * してこのオペレーションが呼び出された場合には、スレーブマネージャ
+ * に対してコンポーネントの生成を依頼する。依頼対象となるスレーブマ
+ * ネージャは、create_component() の引数内パラメータ manager_name
+ * により指定されたマネージャが配下にある場合は、そのマネージャに対
+ * して、create_component() を呼び出すことで生成、manager_name で指
+ * 定されたマネージャがない場合は、新規にスレーブマネージャを起動し
+ * てからコンポーネントを生成する。
*
- * @return À¸À®¤µ¤ì¤¿RT¥³¥ó¥Ý¡¼¥Í¥ó¥È
+ * - manager_nameで指定されたスレーブが存在する場合
+ * <pre>
+ * (maanger_name = servo)
+ * [ app ] [ master ] [ slave ] [ RTC ]
+ * | create_comp() | | .
+ * |---------------->| | .
+ * | manager_name = |--, search | .
+ * | servo | | slaves | .
+ * | |<-' | .
+ * | | create_comp() | .
+ * | |---------------->| .
+ * | | |--, .
+ * | | | |createComp() .
+ * | | |<-' .
+ * | | |.....create...> .
+ * | | | |
+ * | | | |
+ * </pre>
*
+ * - manager_nameで指定されたスレーブが存在しない場合
+ * <pre>
+ * [ app ] [ master ] [ slave ] [ RTC ]
+ * | create_comp() | . .
+ * |---------------->| . .
+ * | manager_name = |--, search . .
+ * | controller | | slaves . .
+ * | |<-' . .
+ * | | launch proc . .
+ * | |---------------->| .
+ * | | create_comp() | .
+ * | |---------------->| .
+ * | | |--, .
+ * | | | |createComp() .
+ * | | |<-' .
+ * | | |.....create...> .
+ * | | | |
+ * | | | |
+ * </pre>
+ *
+ * 指定パラメータ
+ * - manager_name: コンポーネントを起動するスレーブマネージャ名
+ * - 名前指定: <manager_name>
+ * - アドレス指定: <hostname>:<port>
+ * - language: 起動対象のコンポーネントの実装言語
+ *
+ * @param module_name 生成対象RTコンポーネントIDおよびコンフィギュ
+ * レーション引数。フォーマットは大きく分けて
+ * "id" と "configuration" 部分が存在する。
+ *
+ * comp_args: [id]?[configuration]
+ * id は必須、configurationはオプション
+ * id: RTC:[vendor]:[category]:[implementation_id]:[version]
+ * RTC は固定かつ必須
+ * vendor, category, version はオプション
+ * implementation_id は必須
+ * オプションを省略する場合でも ":" は省略不可
+ * configuration: [key0]=[value0]&[key1]=[value1]&[key2]=[value2].....
+ * RTCが持つPropertiesの値をすべて上書きすることができる。
+ * key=value の形式で記述し、"&" で区切る
+ *
+ * @return 生成されたRTコンポーネント
+ *
* @else
* @brief Creating an RT-Component
*
@@ -176,11 +425,15 @@
/*!
* @if jp
- * @brief ¥³¥ó¥Ý¡¼¥Í¥ó¥È¤òºï½ü¤¹¤ë
+ * @brief コンポーネントを削除する
*
- * °ú¿ô¤Ë»ØÄꤵ¤ì¤¿¥³¥ó¥Ý¡¼¥Í¥ó¥È¤òºï½ü¤¹¤ë¡£
+ * 引数に指定されたコンポーネントを削除する。マスターマネージャに対
+ * してこのオペレーションが呼び出された場合、配下のスレーブコンポー
+ * ネント上の当該コンポーネントを削除する。ただし、通常は対象コンポー
+ * ネントに対して exit() オペレーションを呼び出すことで RTC を終了
+ * させる方法を推奨する。
*
- * @return ¥ê¥¿¡¼¥ó¥³¡¼¥É
+ * @return リターンコード
*
* @else
* @brief Deleting an RT-Component
@@ -196,11 +449,15 @@
/*!
* @if jp
- * @brief µ¯Æ°Ãæ¤Î¥³¥ó¥Ý¡¼¥Í¥ó¥È¤Î¥ê¥¹¥È¤ò¼èÆÀ¤¹¤ë
+ * @brief 起動中のコンポーネントのリストを取得する
*
- * ¸½ºßÅö³º¥Þ¥Í¡¼¥¸¥ã¾å¤Çµ¯Æ°Ãæ¤Î¥³¥ó¥Ý¡¼¥Í¥ó¥È¤Î¥ê¥¹¥È¤òÊÖ¤¹¡£
+ * 現在当該マネージャ上で起動中のコンポーネントのリストを返す。マス
+ * ターマネージャに対してこのオペレーションが呼び出された場合、配下
+ * のスレーブコンポーネント上で実行中のRTCのリストを収集して返す。
+ * スレーブマネージャに対して呼び出された場合には、自身が管理する起
+ * 動中のRTCのリストのみを返す。
*
- * @return RT¥³¥ó¥Ý¡¼¥Í¥ó¥È¤Î¥ê¥¹¥È
+ * @return RTコンポーネントのリスト
*
* @else
* @brief Getting RT-Component list running on this manager
@@ -215,12 +472,16 @@
/*!
* @if jp
- * @brief µ¯Æ°Ãæ¤Î¥³¥ó¥Ý¡¼¥Í¥ó¥È¥×¥í¥Õ¥¡¥¤¥ë¤Î¥ê¥¹¥È¤ò¼èÆÀ¤¹¤ë
+ * @brief 起動中のコンポーネントプロファイルのリストを取得する
*
- * ¸½ºßÅö³º¥Þ¥Í¡¼¥¸¥ã¾å¤Çµ¯Æ°Ãæ¤Î¥³¥ó¥Ý¡¼¥Í¥ó¥È¤Î¥×¥í¥Õ¥¡¥¤¥ë¤Î¥ê¥¹
- * ¥È¤òÊÖ¤¹¡£
+ * 現在当該マネージャ上で起動中のコンポーネントのプロファイルのリス
+ * トを返す。マスターマネージャに対してこのオペレーションが呼び出さ
+ * れた場合、配下のスレーブコンポーネント上で実行中のRTCのプロファ
+ * イルリストを収集して返す。スレーブマネージャに対して呼び出された
+ * 場合には、自身が管理する起動中のRTCのプロファイルリストのみを返
+ * す。
*
- * @return RT¥³¥ó¥Ý¡¼¥Í¥ó¥È¥×¥í¥Õ¥¡¥¤¥ë¤Î¥ê¥¹¥È
+ * @return RTコンポーネントプロファイルのリスト
*
* @else
* @brief Getting RT-Component's profile list running on this manager
@@ -234,16 +495,37 @@
*/
RTC::ComponentProfileList get_component_profiles();
- // manager ´ðËÜ
/*!
* @if jp
- * @brief ¥Þ¥Í¡¼¥¸¥ã¤Î¥×¥í¥Õ¥¡¥¤¥ë¤ò¼èÆÀ¤¹¤ë
+ * @brief 指定名のRTCオブジェクトリファレンスを取得
*
- * ¸½ºßÅö³º¥Þ¥Í¡¼¥¸¥ã¤Î¥×¥í¥Õ¥¡¥¤¥ë¤ò¼èÆÀ¤¹¤ë¡£
+ *
*
- * @return ¥Þ¥Í¡¼¥¸¥ã¥×¥í¥Õ¥¡¥¤¥ë
+ * @param name RTC名
+ * @return RTCリスト
*
* @else
+ * @brief
+ *
+ *
+ *
+ * @param name name
+ * @return list of RTC
+ *
+ * @endig
+ */
+ RTC::RTCList get_components_by_name(in string name);
+
+ // manager 基本
+ /*!
+ * @if jp
+ * @brief マネージャのプロファイルを取得する
+ *
+ * 現在当該マネージャのプロファイルを取得する。
+ *
+ * @return マネージャプロファイル
+ *
+ * @else
* @brief Getting this manager's profile.
*
* This operation returns this manager's profile.
@@ -256,11 +538,11 @@
/*!
* @if jp
- * @brief ¥Þ¥Í¡¼¥¸¥ã¤Î¥³¥ó¥Õ¥£¥®¥å¥ì¡¼¥·¥ç¥ó¤ò¼èÆÀ¤¹¤ë
+ * @brief マネージャのコンフィギュレーションを取得する
*
- * ¸½ºßÅö³º¥Þ¥Í¡¼¥¸¥ã¤Î¥³¥ó¥Õ¥£¥®¥å¥ì¡¼¥·¥ç¥ó¤ò¼èÆÀ¤¹¤ë¡£
+ * 現在当該マネージャのコンフィギュレーションを取得する。
*
- * @return ¥Þ¥Í¡¼¥¸¥ã¥³¥ó¥Õ¥£¥®¥å¥ì¡¼¥·¥ç¥ó
+ * @return マネージャコンフィギュレーション
*
* @else
* @brief Getting this manager's configuration.
@@ -275,13 +557,13 @@
/*!
* @if jp
- * @brief ¥Þ¥Í¡¼¥¸¥ã¤Î¥³¥ó¥Õ¥£¥®¥å¥ì¡¼¥·¥ç¥ó¤òÀßÄꤹ¤ë
+ * @brief マネージャのコンフィギュレーションを設定する
*
- * ¸½ºßÅö³º¥Þ¥Í¡¼¥¸¥ã¤Î¥³¥ó¥Õ¥£¥®¥å¥ì¡¼¥·¥ç¥ó¤òÀßÄꤹ¤ë¡£
+ * 現在当該マネージャのコンフィギュレーションを設定する。
*
- * @param name ¥»¥Ã¥È¤¹¤ë¥³¥ó¥Õ¥£¥®¥å¥ì¡¼¥·¥ç¥ó¤Î¥¡¼Ì¾
- * @param value ¥»¥Ã¥È¤¹¤ë¥³¥ó¥Õ¥£¥®¥å¥ì¡¼¥·¥ç¥ó¤ÎÃÍ
- * @return ¥ê¥¿¡¼¥ó¥³¡¼¥É
+ * @param name セットするコンフィギュレーションのキー名
+ * @param value セットするコンフィギュレーションの値
+ * @return リターンコード
*
* @else
* @brief Setting manager's configuration
@@ -298,12 +580,12 @@
/*!
* @if jp
- * @brief ¥Þ¥Í¡¼¥¸¥ã¤¬¥Þ¥¹¥¿¡¼¤«¤É¤¦¤«
+ * @brief マネージャがマスターかどうか
*
- * ¤³¤Î´Ø¿ô¤Ï¥Þ¥Í¡¼¥¸¥ã¤¬¥Þ¥¹¥¿¡¼¤«¤É¤¦¤«¤òÊÖ¤¹¡£True¤Ê¤é¤Ð¡¢Åö³º¥Þ
- * ¥Í¡¼¥¸¥ã¤Ï¥Þ¥¹¥¿¡¼¤Ç¤¢¤ê¡¢¤½¤ì°Ê³°¤Ï False ¤òÊÖ¤¹¡£
+ * この関数はマネージャがマスターかどうかを返す。Trueならば、当該マ
+ * ネージャはマスターであり、それ以外は False を返す。
*
- * @return ¥Þ¥¹¥¿¡¼¥Þ¥Í¡¼¥¸¥ã¤«¤É¤¦¤«¤ÎboolÃÍ
+ * @return マスターマネージャかどうかのbool値
*
* @else
* @brief Whether this manager is master or not
@@ -319,13 +601,16 @@
/*!
* @if jp
- * @brief ¥Þ¥¹¥¿¡¼¥Þ¥Í¡¼¥¸¥ã¤Î¼èÆÀ
+ * @brief マスターマネージャの取得
*
- * ¤³¤Î¥Þ¥Í¡¼¥¸¥ã¤¬¥¹¥ì¡¼¥Ö¥Þ¥Í¡¼¥¸¥ã¤Î¾ì¹ç¡¢¥Þ¥¹¥¿¡¼¤È¤Ê¤Ã¤Æ¤¤¤ë¥Þ
- * ¥Í¡¼¥¸¥ã¤Î¥ê¥¹¥È¤òÊÖ¤¹¡£¤³¤Î¥Þ¥Í¡¼¥¸¥ã¤¬¥Þ¥¹¥¿¡¼¤Î¾ì¹ç¡¢¶õ¤Î¥ê¥¹
- * ¥È¤¬Ê֤롣
+ * このマネージャがスレーブマネージャの場合、マスターとなっているマ
+ * ネージャのリストを返す。このマネージャがマスターの場合、空のリス
+ * トが返る。原則としてスレーブマネージャは1つのマスターマネージャ
+ * の配下となるが、実装上はマスターマネージャは唯一となるような制約
+ * はなく、add_master_manager() オペレーションにより複数のマスター
+ * マネージャを登録することが可能である。
*
- * @return ¥Þ¥¹¥¿¡¼¥Þ¥Í¡¼¥¸¥ã¤Î¥ê¥¹¥È
+ * @return マスターマネージャのリスト
*
* @else
* @brief Getting master managers
@@ -342,11 +627,51 @@
/*!
* @if jp
- * @brief ¥Þ¥¹¥¿¡¼¥Þ¥Í¡¼¥¸¥ã¤ÎÄɲÃ
+ * @brief マスターマネージャの追加
*
- * ¤³¤Î¥Þ¥Í¡¼¥¸¥ã¤Î¥Þ¥¹¥¿¤È¤·¤Æ¥Þ¥Í¡¼¥¸¥ã¤ò°ì¤ÄÄɲ乤롣
+ * このマネージャのマスタとしてマネージャを一つ追加する。
*
- * @param mgr ¥Þ¥¹¥¿¡¼¥Þ¥Í¡¼¥¸¥ã
+ * マスターマネージャとスレーブマネージャの関係は、以下の図のように、
+ * 一つのノード (node: 1つの独立したコンピュータでありホスト) に対
+ * して、1つのマスター (master) マネージャが対応する。1つのマスター
+ * マネージャの下には0個以上のスレーブ (slave) マネージャが存在し、
+ * RTCは1つのスレーブマネージャに属する。なお、スレーブマネージャは
+ * 通常、1つ以上のRTCをホストする。デフォルトの設定では、RTCをホス
+ * トしていないスレーブマネージャは自動終了する。
+ *
+ * <pre>
+ * 1 1 1 0..* 1 1..*
+ * [ node ]<>--------[ master ]<>--------[ slave ]<>--------[ RTC ]
+ *
+ * </pre>
+ *
+ * マスターとスレーブの関係は、add/remove_master_manager(),
+ * add_remove_slave_manager() オペレーションによって構成される。こ
+ * れらのオペレーションは原則として、すべてスレーブマネージャからア
+ * クションを開始する。マスターマネージャは原則として、
+ * corbaloc://localhost:2810/manager によりオブジェクト参照を取得で
+ * きる一方、スレーブマネージャの参照を知る一般的方法はない。スレー
+ * ブマネージャは、起動時にローカルのマスターマネージャを探して、内
+ * 部的にこのオペレーションを呼び出し、マスターマネージャを追加する
+ * とともに、マスターマネージャに対して、add_slabe_manager() を呼び
+ * 出して、マスターマネージャに対して、スレーブマネージャが配下に入っ
+ * たことを知らせる。
+ *
+ * <pre>
+ * [ master ] [ slave ]
+ * | |
+ * | |--, find master
+ * | | | by corbaloc:
+ * | |<-'
+ * | |
+ * | |--,
+ * | | | add_master_manager()
+ * | add_slave_manager(own_ref)|<-'
+ * |<--------------------------|
+ * | |
+ * </pre>
+ *
+ * @param mgr マスターマネージャ
* @return ReturnCode_t
*
* @else
@@ -363,11 +688,29 @@
/*!
* @if jp
- * @brief ¥Þ¥¹¥¿¡¼¥Þ¥Í¡¼¥¸¥ã¤Îºï½ü
+ * @brief マスターマネージャの削除
*
- * ¤³¤Î¥Þ¥Í¡¼¥¸¥ã¤¬ÊÝ»ý¤¹¤ë¥Þ¥¹¥¿¤Î¤¦¤Á¡¢»ØÄꤵ¤ì¤¿¤â¤Î¤òºï½ü¤¹¤ë¡£
+ * このマネージャが保持するマスタのうち、指定されたものを削除する。
+ * 通常このオペレーションは、スレーブマネージャが終了する際に、自身
+ * に対して呼び出される。また、スレーブマネージャ自身がマスターマネー
+ * ジャの配下から外れることを remove_slave_manager() により、マスター
+ * マネージャに対して通知する。
*
- * @param mgr ¥Þ¥¹¥¿¡¼¥Þ¥Í¡¼¥¸¥ã
+ * <pre>
+ * [ master ] [ slave ]
+ * | |
+ * | |--, shutdown
+ * | | | slave manager
+ * | |<-'
+ * | |
+ * | |--,
+ * | | | remove_master_manager()
+ * | remove_slave_manager(own_ref) |<-'
+ * |<------------------------------|
+ * | |
+ * </pre>
+ *
+ * @param mgr マスターマネージャ
* @return ReturnCode_t
*
* @else
@@ -384,13 +727,13 @@
/*!
* @if jp
- * @brief ¥¹¥ì¡¼¥Ö¥Þ¥Í¡¼¥¸¥ã¤Î¼èÆÀ
+ * @brief スレーブマネージャの取得
*
- * ¤³¤Î¥Þ¥Í¡¼¥¸¥ã¤¬¥¹¥ì¡¼¥Ö¥Þ¥Í¡¼¥¸¥ã¤Î¾ì¹ç¡¢¥¹¥ì¡¼¥Ö¤È¤Ê¤Ã¤Æ¤¤¤ë¥Þ
- * ¥Í¡¼¥¸¥ã¤Î¥ê¥¹¥È¤òÊÖ¤¹¡£¤³¤Î¥Þ¥Í¡¼¥¸¥ã¤¬¥¹¥ì¡¼¥Ö¤Î¾ì¹ç¡¢¶õ¤Î¥ê¥¹
- * ¥È¤¬Ê֤롣
+ * このマネージャがスレーブマネージャの場合、スレーブとなっているマ
+ * ネージャのリストを返す。このマネージャがスレーブの場合、空のリス
+ * トが返る。
*
- * @return ¥¹¥ì¡¼¥Ö¥Þ¥Í¡¼¥¸¥ã¤Î¥ê¥¹¥È
+ * @return スレーブマネージャのリスト
*
* @else
* @brief Getting slave managers
@@ -404,13 +747,33 @@
* @endig
*/
ManagerList get_slave_managers();
+
/*!
* @if jp
- * @brief ¥¹¥ì¡¼¥Ö¥Þ¥Í¡¼¥¸¥ã¤ÎÄɲÃ
+ * @brief スレーブマネージャの追加
*
- * ¤³¤Î¥Þ¥Í¡¼¥¸¥ã¤Î¥Þ¥¹¥¿¤È¤·¤Æ¥Þ¥Í¡¼¥¸¥ã¤ò°ì¤ÄÄɲ乤롣
+ * このマネージャのマスタとしてマネージャを一つ追加する。通常、スレー
+ * ブマネージャは、起動時にローカルのマスターマネージャを探して、内
+ * 部的に、add_master_manager() を呼び出し、マスターマネージャを追
+ * 加するとともに、マスターマネージャに対して、この
+ * add_slave_manager() を呼び出して、マスターマネージャに対して、ス
+ * レーブマネージャが配下に入ったことを知らせる。
*
- * @param mgr ¥¹¥ì¡¼¥Ö¥Þ¥Í¡¼¥¸¥ã
+ * <pre>
+ * [ master ] [ slave ]
+ * | |
+ * | |--, find master
+ * | | | by corbaloc:
+ * | |<-'
+ * | |
+ * | |--,
+ * | | | add_master_manager()
+ * | add_slave_manager(own_ref)|<-'
+ * |<--------------------------|
+ * | |
+ * </pre>
+ *
+ * @param mgr スレーブマネージャ
* @return ReturnCode_t
*
* @else
@@ -417,7 +780,7 @@
* @brief Getting a slave manager
*
* This operation add a slave manager to this manager.
- *
+ *
* @param mgr A slave manager
* @return ReturnCode_t
*
@@ -427,11 +790,30 @@
/*!
* @if jp
- * @brief ¥¹¥ì¡¼¥Ö¥Þ¥Í¡¼¥¸¥ã¤Îºï½ü
+ * @brief スレーブマネージャの削除
*
- * ¤³¤Î¥Þ¥Í¡¼¥¸¥ã¤¬ÊÝ»ý¤¹¤ë¥Þ¥¹¥¿¤Î¤¦¤Á¡¢»ØÄꤵ¤ì¤¿¤â¤Î¤òºï½ü¤¹¤ë¡£
+ * このマネージャが保持するマスタのうち、指定されたものを削除する。
+ * 通常このオペレーションは、スレーブマネージャが終了する際に、自身
+ * に対して remove_master_manager() を呼び出した後、スレーブマネー
+ * ジャ自身がマスターマネージャの配下から外れることを知らせるための、
+ * この remove_slave_manager() をマスターマネージャに対して呼ぶこと
+ * で通知する。
*
- * @param mgr ¥¹¥ì¡¼¥Ö¥Þ¥Í¡¼¥¸¥ã
+ * <pre>
+ * [ master ] [ slave ]
+ * | |
+ * | |--, shutdown
+ * | | | slave manager
+ * | |<-'
+ * | |
+ * | |--,
+ * | | | remove_master_manager()
+ * | remove_slave_manager(own_ref) |<-'
+ * |<------------------------------|
+ * | |
+ * </pre>
+ *
+ * @param mgr スレーブマネージャ
* @return ReturnCode_t
*
* @else
@@ -438,44 +820,78 @@
* @brief Removing a slave manager
*
* This operation removes a slave manager from this manager.
- *
+ *
* @param mgr A slave manager
- * @return ReturnCode_t
+ * @return ReturnCode_t
*
* @endig
*/
RTC::ReturnCode_t remove_slave_manager(in Manager mgr);
+ // プロセス操作関係
+ /*!
+ * @if jp
+ * @brief マネージャプロセスをforkする
+ *
+ * @return Return Code
+ *
+ * @else
+ * @brief fork the manager process
+ *
+ * @return Return Code
+ *
+ * @endig
+ */
RTC::ReturnCode_t fork();
+
+ /*!
+ * @if jp
+ * @brief マネージャプロセスをshutdownする
+ *
+ * @return Return Code
+ *
+ * @else
+ * @brief shutdown the manager process
+ *
+ * @return Return Code
+ *
+ * @endig
+ */
RTC::ReturnCode_t shutdown();
+
+ /*!
+ * @if jp
+ * @brief マネージャプロセスを再起動する
+ *
+ * @return Return Code
+ *
+ * @else
+ * @brief restart maanger process
+ *
+ * @return Return Code
+ *
+ * @endig
+ */
RTC::ReturnCode_t restart();
-
- /*!
+ /*!
* @if jp
- * @brief »ØÄê̾¤ÎRTC¥ª¥Ö¥¸¥§¥¯¥È¥ê¥Õ¥¡¥ì¥ó¥¹¤ò¼èÆÀ
+ * @brief サービスのオブジェクト参照を取得する
*
- *
+ * 仕様未確定
*
- * @param name RTC̾
- * @return RTC¥ê¥¹¥È
+ * @return Return Code
*
* @else
- * @brief
+ * @brief obtaining the object reference of a service
*
+ * @return Return Code
*
- *
- * @param name name
- * @return list of RTC
- *
* @endig
*/
- RTC::RTCList get_components_by_name(in string name);
-
Object get_service(in string name);
// ServiceProfileList get_service_profiles();
};
-
}; // end of namespace RTM
#endif // __MANAGER_IDL__
More information about the openrtm-commit
mailing list