ManagerのCORBA化クラス [詳解]

#include <ManagerServant.h>

RTM::ManagerServant の継承関係図

RTM::ManagerServant 連携図

公開メンバ関数
	ManagerServant ()
	コンストラクタ [詳解]

virtual	~ManagerServant (void)
	仮想デストラクタ [詳解]

RTC::ReturnCode_t	load_module (const char pathname, const char initfunc)
	モジュールをロードする [詳解]

RTC::ReturnCode_t	unload_module (const char *pathname)
	モジュールをアンロードする [詳解]

RTM::ModuleProfileList *	get_loadable_modules ()
	ロード可能なモジュールのプロファイルを取得する [詳解]

RTM::ModuleProfileList *	get_loaded_modules ()
	ロード済みのモジュールのプロファイルを取得する [詳解]

RTM::ModuleProfileList *	get_factory_profiles ()
	コンポーネントファクトリのプロファイルを取得する [詳解]

RTC::RTObject_ptr	create_component (const char *module_name)
	コンポーネントを生成する [詳解]

RTC::ReturnCode_t	delete_component (const char *instance_name)
	コンポーネントを削除する [詳解]

RTC::RTCList *	get_components ()
	起動中のコンポーネントのリストを取得する [詳解]

RTC::ComponentProfileList *	get_component_profiles ()
	起動中のコンポーネントプロファイルのリストを取得する [詳解]

RTM::ManagerProfile *	get_profile ()
	マネージャのプロファイルを取得する [詳解]

RTM::NVList *	get_configuration ()
	マネージャのコンフィギュレーションを取得する [詳解]

RTC::ReturnCode_t	set_configuration (const char name, const char value)
	マネージャのコンフィギュレーションを設定する [詳解]

::CORBA::Boolean	is_master ()
	マネージャがマスターかどうか [詳解]

RTM::ManagerList *	get_master_managers ()
	マスターマネージャの取得 [詳解]

RTC::ReturnCode_t	add_master_manager (RTM::Manager_ptr mgr)
	マスターマネージャの追加 [詳解]

RTC::ReturnCode_t	remove_master_manager (RTM::Manager_ptr mgr)
	マスターマネージャの削除 [詳解]

RTM::ManagerList *	get_slave_managers ()
	スレーブマネージャの取得 [詳解]

RTC::ReturnCode_t	add_slave_manager (RTM::Manager_ptr mgr)
	スレーブマネージャの追加 [詳解]

RTC::ReturnCode_t	remove_slave_manager (RTM::Manager_ptr mgr)
	スレーブマネージャの削除 [詳解]

RTC::ReturnCode_t	fork ()
	プロセスのコピーを生成する [詳解]

RTC::ReturnCode_t	shutdown ()
	shutdownする [詳解]

RTC::ReturnCode_t	restart ()
	再起動する。 [詳解]

RTC::RTCList *	get_components_by_name (const char *name)
	指定名のRTCオブジェクトリファレンスを取得 [詳解]

CORBA::Object_ptr	get_service (const char *name)
	RTCのリファレンスを取得する。 [詳解]

RTM::Manager_ptr	getObjRef () const
	Managerのリファレンスを取得する。 [詳解]

bool	createINSManager ()
	INSManagerの生成 [詳解]

RTM::Manager_ptr	findManager (const std::string &host_port)
	Managerのリファレンスを検索する。 [詳解]

RTM::Manager_ptr	findManagerByName (const std::string mgr_name)
	指定名のマネージャを取得 [詳解]

RTM::Manager_ptr	findManagerFromList (const std::string name, RTM::ManagerList &mlist)
	マネージャのリストから指定名を持つマネージャを取得 [詳解]

RTC::RTObject_ptr	createComponentByManagerName (const std::string module_name)
	指定のマネージャでRTCを起動する [詳解]

RTC::RTObject_ptr	createComponentByAddress (const std::string module_name)

void	updateMasterManager ()

std::string	getParameterByModulename (const std::string param_name, std::string &module_name)

bool	isProcessIDManager (std::string mgrname)

詳解

ManagerのCORBA化クラス

ManagerをCORBAサーバント化し、外部からコンポーネントの生成・削除、システム状態の取得などが行える。

構築子と解体子

RTM::ManagerServant::ManagerServant ( )

コンストラクタ

virtual RTM::ManagerServant::~ManagerServant ( void )

virtual

仮想デストラクタ

関数詳解

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

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

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

戻り値: マスターマネージャ

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

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

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

引数

mgr スレーブマネージャ

戻り値: ReturnCode_t

RTC::RTObject_ptr RTM::ManagerServant::create_component ( const char * module_name )

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

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

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

RTC::RTObject_ptr RTM::ManagerServant::createComponentByAddress ( const std::string module_name )

RTC::RTObject_ptr RTM::ManagerServant::createComponentByManagerName ( const std::string module_name )

指定のマネージャでRTCを起動する

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

引数

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

戻り値: 生成されたRTCのオブジェクト参照

bool RTM::ManagerServant::createINSManager ( )

INSManagerの生成

戻り値

RTC::ReturnCode_t RTM::ManagerServant::delete_component ( const char * instance_name )

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

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

戻り値: リターンコード

RTM::Manager_ptr RTM::ManagerServant::findManager ( const std::string & host_port )

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

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

RTM::Manager_ptr RTM::ManagerServant::findManagerByName ( const std::string mgr_name )

指定名のマネージャを取得

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

引数

manager_name マネージャ名

戻り値: マネージャの参照

RTM::Manager_ptr RTM::ManagerServant::findManagerFromList	(	const std::string	name,
		RTM::ManagerList &	mlist
	)

マネージャのリストから指定名を持つマネージャを取得

引数に与えられたマネージャに対して、指定されたマネージャ名を持つマネージャの参照を返すとともに、もしなければ、再帰的にスレーブマネージャを探索して、指定された名称を持つマネージャの参照を返す。この関数はクラス内から呼ぶための内部関数である。引数に与えるマネージャリストは必要に応じてMutexで保護すること。

引数

manager_name	マネージャ名
mlist	マネージャのリスト

戻り値: マネージャの参照

RTC::ReturnCode_t RTM::ManagerServant::fork ( )

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

戻り値: ReturnCode_t

RTC::ComponentProfileList* RTM::ManagerServant::get_component_profiles ( )

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

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

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

RTC::RTCList* RTM::ManagerServant::get_components ( )

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

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

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

RTC::RTCList* RTM::ManagerServant::get_components_by_name ( const char * name )

指定名のRTCオブジェクトリファレンスを取得

引数

name RTC名

戻り値: RTCリスト

RTM::NVList* RTM::ManagerServant::get_configuration ( )

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

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

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

RTM::ModuleProfileList* RTM::ManagerServant::get_factory_profiles ( )

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

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

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

RTM::ModuleProfileList* RTM::ManagerServant::get_loadable_modules ( )

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

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

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

RTM::ModuleProfileList* RTM::ManagerServant::get_loaded_modules ( )

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

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

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

RTM::ManagerList* RTM::ManagerServant::get_master_managers ( )

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

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

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

RTM::ManagerProfile* RTM::ManagerServant::get_profile ( )

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

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

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

CORBA::Object_ptr RTM::ManagerServant::get_service ( const char * name )

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

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

RTM::ManagerList* RTM::ManagerServant::get_slave_managers ( )

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

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

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

RTM::Manager_ptr RTM::ManagerServant::getObjRef ( ) const

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

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

std::string RTM::ManagerServant::getParameterByModulename	(	const std::string	param_name,
		std::string &	module_name
	)

::CORBA::Boolean RTM::ManagerServant::is_master ( )

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

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

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

bool RTM::ManagerServant::isProcessIDManager ( std::string mgrname )

RTC::ReturnCode_t RTM::ManagerServant::load_module	(	const char *	pathname,
		const char *	initfunc
	)

モジュールをロードする

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

引数

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

戻り値: リターンコード

standard constructor

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

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

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

引数

mgr マスターマネージャ

戻り値: ReturnCode_t

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

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

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

引数

mgr スレーブマネージャ

戻り値: ReturnCode_t

RTC::ReturnCode_t RTM::ManagerServant::restart ( )

再起動する。

戻り値: ReturnCode_t

RTC::ReturnCode_t RTM::ManagerServant::set_configuration	(	const char *	name,
		const char *	value
	)

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

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

引数

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

戻り値: リターンコード

RTC::ReturnCode_t RTM::ManagerServant::shutdown ( )

shutdownする

戻り値: ReturnCode_t

RTC::ReturnCode_t RTM::ManagerServant::unload_module ( const char * pathname )

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

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

引数

pathname モジュールへのパス

戻り値: リターンコード

void RTM::ManagerServant::updateMasterManager ( )

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

ManagerServant.h

公開メンバ関数

詳解

構築子と解体子

関数詳解