Manager CORBA class. More...

#include <ManagerServant.h>

Inheritance diagram for RTM::ManagerServant:

[legend]

Collaboration diagram for RTM::ManagerServant:

[legend]

Public Member Functions
	ManagerServant ()
	Constructor.

	~ManagerServant () override
	Virtual destructor.

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

RTC::ReturnCode_t	unload_module (const char *pathname) override
	Unloading a module.

RTM::ModuleProfileList *	get_loadable_modules () override
	Getting loadable module profiles.

RTM::ModuleProfileList *	get_loaded_modules () override
	Getting loaded module profiles.

RTM::ModuleProfileList *	get_factory_profiles () override
	Getting component factory profiles.

RTC::RTObject_ptr	create_component (const char *module_name) override
	Creating an RT-Component.

RTC::ReturnCode_t	delete_component (const char *instance_name) override
	Deleting an RT-Component.

RTC::RTCList *	get_components () override
	Getting RT-Component list running on this manager.

RTC::ComponentProfileList *	get_component_profiles () override
	Getting RT-Component's profile list running on this manager.

RTM::ManagerProfile *	get_profile () override
	Getting this manager's profile.

RTM::NVList *	get_configuration () override
	Getting this manager's configuration.

RTC::ReturnCode_t	set_configuration (const char name, const char value) override
	Setting manager's configuration.

::CORBA::Boolean	is_master () override
	Whether this manager is master or not.

RTM::ManagerList *	get_master_managers () override
	Getting master managers.

RTC::ReturnCode_t	add_master_manager (RTM::Manager_ptr mgr) override
	Getting a master manager.

RTC::ReturnCode_t	remove_master_manager (RTM::Manager_ptr mgr) override
	Removing a master manager.

RTM::ManagerList *	get_slave_managers () override
	Getting slave managers.

RTC::ReturnCode_t	add_slave_manager (RTM::Manager_ptr mgr) override
	Getting a slave manager.

RTC::ReturnCode_t	remove_slave_manager (RTM::Manager_ptr mgr) override
	Removing a slave manager.

RTC::ReturnCode_t	fork () override
	The copy of the process is generated.

RTC::ReturnCode_t	shutdown () override
	This method shutdowns RTC.

RTC::ReturnCode_t	restart () override
	This method restarts RTC.

RTC::RTCList *	get_components_by_name (const char *name) override

CORBA::Object_ptr	get_service (const char *name) override
	Get the reference of RTC.

RTM::Manager_ptr	getObjRef () const
	Get the reference of Manager.

bool	createINSManager ()
	Generate INSManager.

RTM::Manager_ptr	findManager (const std::string &host_port)
	Find the reference of Manager.

RTM::Manager_ptr	findManagerByName (const std::string &mgr_name)
	Obtain Manager's reference by name.

RTM::Manager_ptr	findManagerFromList (const std::string &name, RTM::ManagerList &mlist)
	Obtain Manager's reference by name.

RTC::RTObject_ptr	createComponentByManagerName (std::string &create_arg, std::string &mgrstr)
	Launch RTC on specified manager.

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 Public Member Functions
static bool	isProcessIDManager (const std::string &mgrname)

Detailed Description

Manager CORBA class.

This class changes Manager to CORBA Servant. Generation/deletion of the component, to get the state of the system, etc. can be done from the outside.

Constructor & Destructor Documentation

◆ ManagerServant()

RTM::ManagerServant::ManagerServant ( )

Constructor.

Constructor

◆ ~ManagerServant()

RTM::ManagerServant::~ManagerServant ( )

override

Virtual destructor.

Member Function Documentation

◆ add_master_manager()

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

override

Getting a master manager.

This operation returns a master manager with specified id. If the manager with the specified id does not exist, nil object reference would be returned.

Returns: A master manager

◆ add_slave_manager()

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

override

Getting a slave manager.

This operation add a slave manager to this manager.

Parameters

mgr	A slave manager

Returns: ReturnCode_t

◆ create_component()

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

override

Creating an RT-Component.

This operation creates RT-Component according to the string argument.

Returns: A created RT-Component

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

Launch RTC on specified manager.

Manager is specified with "manager_name" key such as "comp&manager_name=mgr" in the RTC launch parameter.

Parameters

module_name Given parameter to create RTC

Returns: created RTObject object reference

◆ createINSManager()

bool RTM::ManagerServant::createINSManager ( )

Generate INSManager.

成功:true, 失敗:false

Returns: Successful:true, Failed:false

◆ delete_component()

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

override

Deleting an RT-Component.

This operation delete an RT-Component according to the string argument.

Returns: Return code

◆ findManager()

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

Find the reference of Manager.

Returns: Manager reference

◆ findManagerByName()

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

Obtain Manager's reference by name.

If this is master manager, find it from the registered slave managers. If this is slave manager, request it to its master manager.

Parameters

manager_name Manager's name

Returns: Manager's object reference

◆ findManagerFromList()

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

Obtain Manager's reference by name.

This function search a specified name manager from the given manager list. And if it is not found, this function also search from its slave managers recursively. This function is internal function. The given manager list must be guarded by mutex.

Parameters

manager_name	Manager's name
mlist	Manager list

Returns: Manager's object reference

◆ fork()

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

override

The copy of the process is generated.

Returns: ReturnCode_t

◆ get_component_profiles()

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

override

Getting RT-Component's profile list running on this manager.

This operation returns RT-Component's profile list running on this manager.

Returns: A list of RT-Components' profiles

◆ get_components()

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

override

Getting RT-Component list running on this manager.

This operation returns RT-Component list running on this manager.

Returns: A list of RT-Components

◆ get_components_by_name()

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

override

Parameters

name name

Returns: list of RTC

@endig

◆ get_configuration()

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

override

Getting this manager's configuration.

This operation returns this manager's configuration.

Returns: Manager's configuration

◆ get_factory_profiles()

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

override

Getting component factory profiles.

This operation returns component factory profiles from loaded RT-Component module factory profiles.

Returns: An RT-Component factory profile list.

◆ get_loadable_modules()

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

override

Getting loadable module profiles.

This operation returns loadable module profiles.

Returns: A module profile list.

◆ get_loaded_modules()

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

override

Getting loaded module profiles.

This operation returns loaded module profiles.

Returns: A module profile list.

◆ get_master_managers()

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

override

Getting master managers.

This operation returns master manager list if this manager is slave. If this manager is master, an empty sequence would be returned.

Returns: Master manager list

◆ get_profile()

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

override

Getting this manager's profile.

This operation returns this manager's profile.

Returns: Manager's profile

◆ get_service()

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

override

Get the reference of RTC.

Returns: RTC reference

◆ get_slave_managers()

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

override

Getting slave managers.

This operation returns slave manager list if this manager is slave. If this manager is slave, an empty sequence would be returned.

Returns: Slave manager list

◆ getObjRef()

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

Get the reference of Manager.

Returns: Manager reference

◆ getParameterByModulename()

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

◆ is_master()

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

override

Whether this manager is master or not.

It returns "True" if this manager is a master, and it returns "False" in other cases.

Returns: A boolean value that means it is master or not.

◆ 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.

Parameters

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

Returns: The return code.

◆ remove_master_manager()

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

override

Removing a master manager.

This operation removes a master manager from this manager.

Parameters

mgr	A master manager

Returns: ReturnCode_t

◆ remove_slave_manager()

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

override

Removing a slave manager.

This operation removes a slave manager from this manager.

Parameters

mgr	A slave manager

Returns: ReturnCode_t

◆ restart()

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

override

This method restarts RTC.

Returns: ReturnCode_t

◆ set_configuration()

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

override

Setting manager's configuration.

This operation sets managers configuration.

Parameters

name	A configuration key name to be set
value	A configuration value to be set

Returns: Return code

◆ shutdown()

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

override

This method shutdowns RTC.

Returns: ReturnCode_t

◆ unload_module()

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

override

Unloading a module.

This operation unloads a specified loadable module.

Parameters

pathname A path to a loading module.

Returns: The return code.

◆ updateMasterManager()

void RTM::ManagerServant::updateMasterManager ( )

The documentation for this class was generated from the following file:

ManagerServant.h

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ManagerServant()

◆ ~ManagerServant()

Member Function Documentation

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