ManagerのCORBA化クラス [詳解]

#include <ManagerServant.h>

RTM::ManagerServant の継承関係図

[凡例]

RTM::ManagerServant 連携図

[凡例]

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

	~ManagerServant () override
	仮想デストラクタ

RTC::ReturnCode_t	load_module (const char pathname, const char initfunc) override
	Loading a module

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

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

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

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

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

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

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

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

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

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

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

::CORBA::Boolean	is_master () override
	マネージャがマスターかどうか

RTM::ManagerList *	get_master_managers () override
	マスターマネージャの取得

RTC::ReturnCode_t	add_master_manager (RTM::Manager_ptr mgr) override
	マスターマネージャの追加

RTC::ReturnCode_t	remove_master_manager (RTM::Manager_ptr mgr) override
	マスターマネージャの削除

RTM::ManagerList *	get_slave_managers () override
	スレーブマネージャの取得

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

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

RTC::ReturnCode_t	fork () override
	プロセスのコピーを生成する

RTC::ReturnCode_t	shutdown () override
	shutdownする

RTC::ReturnCode_t	restart () override
	再起動する。

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

CORBA::Object_ptr	get_service (const char *name) override
	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 (std::string &create_arg, std::string &mgrstr)
	指定のマネージャでRTCを起動する

RTC::RTObject_ptr	createComponentByAddress (std::string &create_arg, std::string &mgrstr)

void	updateMasterManager ()

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

静的公開メンバ関数
static bool	isProcessIDManager (const std::string &mgrname)

詳解

ManagerのCORBA化クラス

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

構築子と解体子

◆ ManagerServant()

RTM::ManagerServant::ManagerServant ( )

コンストラクタ

◆ ~ManagerServant()

RTM::ManagerServant::~ManagerServant ( )

override

仮想デストラクタ

関数詳解

◆ add_master_manager()

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

override

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

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

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

◆ add_slave_manager()

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

override

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

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

引数

mgr スレーブマネージャ

戻り値: ReturnCode_t

◆ create_component()

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

override

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

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

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

◆ createComponentByAddress()

RTC::RTObject_ptr RTM::ManagerServant::createComponentByAddress	(	std::string &	create_arg,
		std::string &	mgrstr )

◆ createComponentByManagerName()

RTC::RTObject_ptr RTM::ManagerServant::createComponentByManagerName	(	std::string &	create_arg,
		std::string &	mgrstr )

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

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

引数

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

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

◆ createINSManager()

bool RTM::ManagerServant::createINSManager ( )

INSManagerの生成

戻り値

◆ delete_component()

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

override

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

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

戻り値: リターンコード

◆ findManager()

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

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

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

◆ findManagerByName()

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

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

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

引数

manager_name マネージャ名

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

◆ findManagerFromList()

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

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

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

引数

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

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

◆ fork()

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

override

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

戻り値: ReturnCode_t

◆ get_component_profiles()

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

override

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

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

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

◆ get_components()

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

override

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

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

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

◆ get_components_by_name()

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

override

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

引数

name RTC名

戻り値: RTCリスト

◆ get_configuration()

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

override

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

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

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

◆ get_factory_profiles()

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

override

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

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

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

◆ get_loadable_modules()

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

override

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

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

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

◆ get_loaded_modules()

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

override

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

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

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

◆ get_master_managers()

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

override

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

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

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

◆ get_profile()

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

override

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

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

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

◆ get_service()

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

override

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

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

◆ get_slave_managers()

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

override

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

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

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

◆ getObjRef()

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

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

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

◆ getParameterByModulename()

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

◆ is_master()

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

override

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

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

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

◆ isProcessIDManager()

static bool RTM::ManagerServant::isProcessIDManager ( const std::string & mgrname )

static

◆ load_module()

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

override

Loading a module

   @if jp
   @brief モジュールをロードする

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

   @param pathname モジュールへのパス
   @param initfunc モジュールの初期化関数
   @return リターンコード

standard constructor

This operation loads a specified loadable module、and perform initialization with the specified function.

引数

pathname	A path to a loading module.
initfunc	Module initialization function.

戻り値: The return code.

◆ remove_master_manager()

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

override

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

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

引数

mgr マスターマネージャ

戻り値: ReturnCode_t

◆ remove_slave_manager()

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

override

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

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

引数

mgr スレーブマネージャ

戻り値: ReturnCode_t

◆ restart()

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

override

再起動する。

戻り値: ReturnCode_t

◆ set_configuration()

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

override

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

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

引数

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

戻り値: リターンコード

◆ shutdown()

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

override

shutdownする

戻り値: ReturnCode_t

◆ unload_module()

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

override

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

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

引数

pathname モジュールへのパス

戻り値: リターンコード

◆ updateMasterManager()

void RTM::ManagerServant::updateMasterManager ( )

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

ManagerServant.h

公開メンバ関数

静的公開メンバ関数

詳解

構築子と解体子

◆ ManagerServant()

◆ ~ManagerServant()

関数詳解

◆ add_master_manager()

◆ add_slave_manager()

◆ create_component()

◆ createComponentByAddress()

◆ createComponentByManagerName()

◆ createINSManager()

◆ delete_component()

◆ findManager()

◆ findManagerByName()

◆ findManagerFromList()

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

◆ isProcessIDManager()

◆ load_module()

◆ remove_master_manager()

◆ remove_slave_manager()

◆ restart()

◆ set_configuration()

◆ shutdown()

◆ unload_module()

◆ updateMasterManager()