OpenRTM_aist.ManagerServant.ManagerServant クラス

OpenRTM_aist.ManagerServant.ManagerServant の継承関係図

クラス
class	is_equiv

公開メンバ関数
def	__init__ (self)
def	__del__ (self)
def	exit (self)
def	load_module (self, pathname, initfunc)
def	unload_module (self, pathname)
def	get_loadable_modules (self)
def	get_loaded_modules (self)
def	get_factory_profiles (self)
def	create_component (self, module_name)
def	delete_component (self, instance_name)
def	get_components (self)
def	get_component_profiles (self)
def	get_profile (self)
def	get_configuration (self)
def	set_configuration (self, name, value)
def	is_master (self)
def	get_master_managers (self)
def	add_master_manager (self, mgr)
def	remove_master_manager (self, mgr)
def	get_slave_managers (self)
def	add_slave_manager (self, mgr)
def	remove_slave_manager (self, mgr)
def	fork (self)
def	shutdown (self)
def	restart (self)
def	get_service (self, name)
def	getObjRef (self)
def	createINSManager (self)
def	findManager (self, host_port)
def	get_components_by_name (self, name)
def	findManagerByName (self, manager_name)
def	getParameterByModulename (self, param_name, module_name)
def	createComponentByManagerName (self, module_name)
def	createComponentByAddress (self, module_name)
def	updateMasterManager (self)

詳解

構築子と解体子

__init__()

def OpenRTM_aist.ManagerServant.ManagerServant.__init__

(

self

)

コンストラクタ

コンストラクタ

__del__()

def OpenRTM_aist.ManagerServant.ManagerServant.__del__

(

self

)

仮想デストラクタ

メソッド詳解

add_master_manager()

def OpenRTM_aist.ManagerServant.ManagerServant.add_master_manager	(		self,
			mgr
	)

マスターマネージャの追加

このマネージャのマスタとしてマネージャを一つ追加する。戻り値には、 当該マネージャ上で追加されたマスターマネージャを識別するユニーク なIDが返される。このマネージャがマスタの場合、当該IDで指定された マスターマネージャを返す。IDで指定されたマスターマネージャがない 場合、nilオブジェクトが返る。

戻り値

マスターマネージャ

RTC::ReturnCode_t add_master_manager(RTM::Manager_ptr mgr);

add_slave_manager()

def OpenRTM_aist.ManagerServant.ManagerServant.add_slave_manager	(		self,
			mgr
	)

スレーブマネージャの追加

このマネージャのマスタとしてマネージャを一つ追加する。

引数

mgr

スレーブマネージャ

戻り値

ReturnCode_t

RTC::ReturnCode_t add_slave_manager(RTM::Manager_ptr mgr);

create_component()

def OpenRTM_aist.ManagerServant.ManagerServant.create_component	(		self,
			module_name
	)

コンポーネントを生成する

引数に指定されたコンポーネントを生成する。

戻り値

生成されたRTコンポーネント

RTObject_ptr create_component(const char* module_name)

createComponentByAddress()

def OpenRTM_aist.ManagerServant.ManagerServant.createComponentByAddress	(		self,
			module_name
	)

指定のマネージャでRTCを起動する comp&manager_address=localhost:2810 のようにRTC名&manager_address=マネージャのホスト名、ポート番号を指定する

引数

self
module_name	起動するRTC、マネージャのホストアドレス

戻り値

RTC RTC::RTObject_ptr createComponentByAddress(string module_name)

createComponentByManagerName()

def OpenRTM_aist.ManagerServant.ManagerServant.createComponentByManagerName	(		self,
			module_name
	)

指定のマネージャでRTCを起動する comp&manager_name=mgr のようにRTC名&manager_name=マネージャ名と指定する

引数

self
module_name	起動するRTC、マネージャ名

戻り値

RTC RTC::RTObject_ptr createComponentByManagerName(string module_name)

createINSManager()

def OpenRTM_aist.ManagerServant.ManagerServant.createINSManager

(

self

)

INSManagerの生成

戻り値

bool createINSManager();

delete_component()

def OpenRTM_aist.ManagerServant.ManagerServant.delete_component	(		self,
			instance_name
	)

コンポーネントを削除する

引数に指定されたコンポーネントを削除する。

戻り値

リターンコード

ReturnCode_t delete_component(const char* instance_name)

exit()

def OpenRTM_aist.ManagerServant.ManagerServant.exit

(

self

)

終了関数

findManager()

def OpenRTM_aist.ManagerServant.ManagerServant.findManager	(		self,
			host_port
	)

Managerのリファレンスを検索する。

戻り値

Managerのリファレンス

RTM::Manager_ptr findManager(const char* host_port);

findManagerByName()

def OpenRTM_aist.ManagerServant.ManagerServant.findManagerByName	(		self,
			manager_name
	)

指定名のマネージャを取得 マネージャがマスターの場合は登録されているスレーブマネージャから検索する マネージャがスレーブの場合は登録されているマスターマネージャからスレーブマネージャを検索する

引数

self
manager_name	マネージャ名

戻り値

マネージャ RTC::Manager_ptr findManagerByName(string manager_name)

fork()

def OpenRTM_aist.ManagerServant.ManagerServant.fork

(

self

)

プロセスのコピーを生成する

戻り値

ReturnCode_t

ReturnCode_t fork()

get_component_profiles()

def OpenRTM_aist.ManagerServant.ManagerServant.get_component_profiles

(

self

)

起動中のコンポーネントプロファイルのリストを取得する

現在当該マネージャ上で起動中のコンポーネントのプロファイルのリス トを返す。

戻り値

RTコンポーネントプロファイルのリスト

ComponentProfileList* get_component_profiles()

get_components()

def OpenRTM_aist.ManagerServant.ManagerServant.get_components

(

self

)

起動中のコンポーネントのリストを取得する

現在当該マネージャ上で起動中のコンポーネントのリストを返す。

戻り値

RTコンポーネントのリスト

RTCList* get_components()

get_components_by_name()

def OpenRTM_aist.ManagerServant.ManagerServant.get_components_by_name	(		self,
			name
	)

指定名のRTCを取得

引数

self
name	RTC名

戻り値

RTCのリスト RTCList get_components_by_name(string name)

get_configuration()

def OpenRTM_aist.ManagerServant.ManagerServant.get_configuration

(

self

)

マネージャのコンフィギュレーションを取得する

現在当該マネージャのコンフィギュレーションを取得する。

戻り値

マネージャコンフィギュレーション

NVList* get_configuration()

get_factory_profiles()

def OpenRTM_aist.ManagerServant.ManagerServant.get_factory_profiles

(

self

)

コンポーネントファクトリのプロファイルを取得する

ロード済みのモジュールのうち、RTコンポーネントのモジュールが持つ ファクトリのプロファイルのリストを取得する。

戻り値

コンポーネントファクトリのプロファイルリスト

ModuleProfileList* get_factory_profiles()

get_loadable_modules()

def OpenRTM_aist.ManagerServant.ManagerServant.get_loadable_modules

(

self

)

ロード可能なモジュールのプロファイルを取得する

ロード可能なモジュールのプロファイルを取得する。

戻り値

モジュールプロファイル

ModuleProfileList* get_loadable_modules()

get_loaded_modules()

def OpenRTM_aist.ManagerServant.ManagerServant.get_loaded_modules

(

self

)

ロード済みのモジュールのプロファイルを取得する

ロード済みのモジュールのプロファイルを取得する。

戻り値

モジュールプロファイル

ModuleProfileList* get_loaded_modules()

get_master_managers()

def OpenRTM_aist.ManagerServant.ManagerServant.get_master_managers

(

self

)

マスターマネージャの取得

このマネージャがスレーブマネージャの場合、マスターとなっているマ ネージャのリストを返す。このマネージャがマスターの場合、空のリス トが返る。

戻り値

マスターマネージャのリスト

RTM::ManagerList* get_master_managers();

get_profile()

def OpenRTM_aist.ManagerServant.ManagerServant.get_profile

(

self

)

マネージャのプロファイルを取得する

現在当該マネージャのプロファイルを取得する。

戻り値

マネージャプロファイル

ManagerProfile* get_profile()

get_service()

def OpenRTM_aist.ManagerServant.ManagerServant.get_service	(		self,
			name
	)

RTCのリファレンスを取得する。

戻り値

RTCのリファレンス

Object_ptr get_service(const char* name)

get_slave_managers()

def OpenRTM_aist.ManagerServant.ManagerServant.get_slave_managers

(

self

)

スレーブマネージャの取得

このマネージャがスレーブマネージャの場合、スレーブとなっているマ ネージャのリストを返す。このマネージャがスレーブの場合、空のリス トが返る。

戻り値

スレーブマネージャのリスト

RTM::ManagerList* get_slave_managers();

getObjRef()

def OpenRTM_aist.ManagerServant.ManagerServant.getObjRef

(

self

)

Managerのリファレンスを取得する。

戻り値

Managerのリファレンス

Manager_ptr getObjRef() const

getParameterByModulename()

def OpenRTM_aist.ManagerServant.ManagerServant.getParameterByModulename	(		self,
			param_name,
			module_name
	)

モジュール名からパラメータを取り出す &param_name=value　もしくは ?param_name=value 　のvalueを取り出す

引数

self
param_name	パラメータ名
module_name	モジュール名

戻り値

パラメータ std::string getParameterByModulename(string param_name, string &module_name)

is_master()

def OpenRTM_aist.ManagerServant.ManagerServant.is_master

(

self

)

マネージャがマスターかどうか

この関数はマネージャがマスターかどうかを返す。Trueならば、当該マ ネージャはマスターであり、それ以外は False を返す。

戻り値

マスターマネージャかどうかのbool値

bool is_master();

load_module()

def OpenRTM_aist.ManagerServant.ManagerServant.load_module	(		self,
			pathname,
			initfunc
	)

モジュールをロードする

当該マネージャに指定されたモジュールをロードし、指定された初期化 関数で初期化を行う。

引数

pathname	モジュールへのパス
initfunc	モジュールの初期化関数

戻り値

リターンコード

ReturnCode_t load_module(const char* pathname, const char* initfunc)

remove_master_manager()

def OpenRTM_aist.ManagerServant.ManagerServant.remove_master_manager	(		self,
			mgr
	)

マスターマネージャの削除

このマネージャが保持するマスタのうち、指定されたものを削除する。

引数

mgr

マスターマネージャ

戻り値

ReturnCode_t

RTC::ReturnCode_t remove_master_manager(RTM::Manager_ptr mgr);

remove_slave_manager()

def OpenRTM_aist.ManagerServant.ManagerServant.remove_slave_manager	(		self,
			mgr
	)

スレーブマネージャの削除

このマネージャが保持するマスタのうち、指定されたものを削除する。

引数

mgr

スレーブマネージャ

戻り値

ReturnCode_t

RTC::ReturnCode_t remove_slave_manager(RTM::Manager_ptr mgr);

restart()

def OpenRTM_aist.ManagerServant.ManagerServant.restart

(

self

)

再起動する。

戻り値

ReturnCode_t

ReturnCode_t restart()

set_configuration()

def OpenRTM_aist.ManagerServant.ManagerServant.set_configuration	(		self,
			name,
			value
	)

マネージャのコンフィギュレーションを設定する

現在当該マネージャのコンフィギュレーションを設定する。

引数

name	セットするコンフィギュレーションのキー名
value	セットするコンフィギュレーションの値

戻り値

リターンコード

ReturnCode_t set_configuration(const char* name, const char* value)

shutdown()

def OpenRTM_aist.ManagerServant.ManagerServant.shutdown

(

self

)

shutdownする

戻り値

ReturnCode_t

ReturnCode_t shutdown()

unload_module()

def OpenRTM_aist.ManagerServant.ManagerServant.unload_module	(		self,
			pathname
	)

モジュールをアンロードする

当該マネージャに指定されたモジュールをアンロードする。

引数

pathname

モジュールへのパス

戻り値

リターンコード

ReturnCode_t unload_module(const char* pathname)

updateMasterManager()

def OpenRTM_aist.ManagerServant.ManagerServant.updateMasterManager

(

self

)

マスターマネージャの有無を確認してリストを更新する

引数

self	void updateMasterManager()

---

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

• C:/docs/OpenRTM-aist-Python/OpenRTM_aist/ManagerServant.py