OpenRTM_aist.ManagerServant.ManagerServant の継承関係図

クラス
class	is_equiv

公開メンバ関数
	__init__ (self)

	__del__ (self)

	exit (self)

	load_module (self, pathname, initfunc)

	unload_module (self, pathname)

	get_loadable_modules (self)

	get_loaded_modules (self)

	get_factory_profiles (self)

	create_component (self, module_name)

	delete_component (self, instance_name)

	get_components (self)

	get_component_profiles (self)

	get_profile (self)

	get_configuration (self)

	set_configuration (self, name, value)

	is_master (self)

	get_master_managers (self)

	add_master_manager (self, mgr)

	remove_master_manager (self, mgr)

	get_slave_managers (self)

	add_slave_manager (self, mgr)

	remove_slave_manager (self, mgr)

	fork (self)

	shutdown (self)

	restart (self)

	get_service (self, name)

	getObjRef (self)

	createINSManager (self)

	findManager (self, host_port)

	get_components_by_name (self, name)

	findManagerByName (self, manager_name)

	getParameterByModulename (self, param_name, module_name)

	createComponentByManagerName (self, module_name)

	createComponentByAddress (self, module_name)

	updateMasterManager (self)

詳解

構築子と解体子

◆ init()

OpenRTM_aist.ManagerServant.ManagerServant.__init__ ( self )

コンストラクタ

◆ del()

OpenRTM_aist.ManagerServant.ManagerServant.__del__ ( self )

仮想デストラクタ

メソッド詳解

◆ add_master_manager()

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()

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

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

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

引数

mgr スレーブマネージャ

戻り値: ReturnCode_t

RTC.ReturnCode_t add_slave_manager(RTM.Manager_ptr mgr);

◆ create_component()

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

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

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

戻り値: 生成されたRTコンポーネント

RTObject_ptr create_component(const char* module_name)

◆ createComponentByAddress()

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()

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()

OpenRTM_aist.ManagerServant.ManagerServant.createINSManager ( self )

INSManagerの生成

戻り値

bool createINSManager();

◆ delete_component()

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

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

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

戻り値: リターンコード

ReturnCode_t delete_component(const char* instance_name)

◆ exit()

OpenRTM_aist.ManagerServant.ManagerServant.exit ( self )

終了関数

◆ findManager()

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

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

戻り値: Managerのリファレンス

RTM.Manager_ptr findManager(const char* host_port);

◆ findManagerByName()

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

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

引数

self
manager_name	マネージャ名

戻り値: マネージャ RTC.Manager_ptr findManagerByName(string manager_name)

◆ fork()

OpenRTM_aist.ManagerServant.ManagerServant.fork ( self )

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

戻り値: ReturnCode_t

ReturnCode_t fork()

◆ get_component_profiles()

OpenRTM_aist.ManagerServant.ManagerServant.get_component_profiles ( self )

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

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

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

ComponentProfileList* get_component_profiles()

◆ get_components()

OpenRTM_aist.ManagerServant.ManagerServant.get_components ( self )

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

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

戻り値: RTコンポーネントのリスト

RTCList* get_components()

◆ get_components_by_name()

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

指定名のRTCを取得

引数

self
name	RTC名

戻り値: RTCのリスト RTCList get_components_by_name(string name)

◆ get_configuration()

OpenRTM_aist.ManagerServant.ManagerServant.get_configuration ( self )

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

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

戻り値: マネージャコンフィギュレーション

NVList* get_configuration()

◆ get_factory_profiles()

OpenRTM_aist.ManagerServant.ManagerServant.get_factory_profiles ( self )

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

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

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

ModuleProfileList* get_factory_profiles()

◆ get_loadable_modules()

OpenRTM_aist.ManagerServant.ManagerServant.get_loadable_modules ( self )

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

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

戻り値: モジュールプロファイル

ModuleProfileList* get_loadable_modules()

◆ get_loaded_modules()

OpenRTM_aist.ManagerServant.ManagerServant.get_loaded_modules ( self )

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

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

戻り値: モジュールプロファイル

ModuleProfileList* get_loaded_modules()

◆ get_master_managers()

OpenRTM_aist.ManagerServant.ManagerServant.get_master_managers ( self )

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

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

戻り値: マスターマネージャのリスト

RTM.ManagerList* get_master_managers();

◆ get_profile()

OpenRTM_aist.ManagerServant.ManagerServant.get_profile ( self )

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

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

戻り値: マネージャプロファイル

ManagerProfile* get_profile()

◆ get_service()

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

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

戻り値: RTCのリファレンス

Object_ptr get_service(const char* name)

◆ get_slave_managers()

OpenRTM_aist.ManagerServant.ManagerServant.get_slave_managers ( self )

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

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

戻り値: スレーブマネージャのリスト

RTM.ManagerList* get_slave_managers();

◆ getObjRef()

OpenRTM_aist.ManagerServant.ManagerServant.getObjRef ( self )

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

戻り値: Managerのリファレンス

Manager_ptr getObjRef() const

◆ getParameterByModulename()

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()

OpenRTM_aist.ManagerServant.ManagerServant.is_master ( self )

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

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

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

bool is_master();

◆ load_module()

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

モジュールをロードする

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

引数

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

戻り値: リターンコード

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

◆ remove_master_manager()

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()

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

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

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

引数

mgr スレーブマネージャ

戻り値: ReturnCode_t

RTC.ReturnCode_t remove_slave_manager(RTM.Manager_ptr mgr);

◆ restart()

OpenRTM_aist.ManagerServant.ManagerServant.restart ( self )

再起動する。

戻り値: ReturnCode_t

ReturnCode_t restart()

◆ set_configuration()

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

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

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

引数

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

戻り値: リターンコード

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

◆ shutdown()

OpenRTM_aist.ManagerServant.ManagerServant.shutdown ( self )

shutdownする

戻り値: ReturnCode_t

ReturnCode_t shutdown()

◆ unload_module()

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

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

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

引数

pathname モジュールへのパス

戻り値: リターンコード

ReturnCode_t unload_module(const char* pathname)

◆ updateMasterManager()

OpenRTM_aist.ManagerServant.ManagerServant.updateMasterManager ( self )

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

引数

self	void updateMasterManager()

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

ManagerServant.py

クラス

公開メンバ関数

詳解

構築子と解体子

◆ __init__()

◆ __del__()

メソッド詳解

◆ add_master_manager()

◆ add_slave_manager()

◆ create_component()

◆ createComponentByAddress()

◆ createComponentByManagerName()

◆ createINSManager()

◆ delete_component()

◆ exit()

◆ findManager()

◆ findManagerByName()

◆ fork()

◆ get_component_profiles()

◆ get_components()

◆ get_components_by_name()

◆ get_configuration()

◆ get_factory_profiles()

◆ get_loadable_modules()

◆ get_loaded_modules()

◆ get_master_managers()

◆ get_profile()

◆ get_service()

◆ get_slave_managers()

◆ getObjRef()

◆ getParameterByModulename()

◆ is_master()

◆ load_module()

◆ remove_master_manager()

◆ remove_slave_manager()

◆ restart()

◆ set_configuration()

◆ shutdown()

◆ unload_module()

◆ updateMasterManager()

◆ init()

◆ del()