Manager CORBA class. More...

#include <ManagerServant.h>

Inheritance diagram for RTM::ManagerServant:

Collaboration diagram for RTM::ManagerServant:

Public Member Functions
	ManagerServant ()
	Constructor. More...

virtual	~ManagerServant (void)
	Virtual destructor. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

bool	createINSManager ()
	Generate INSManager. More...

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

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

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

RTC::RTObject_ptr	createComponentByManagerName (const std::string module_name)
	Launch RTC on specified manager. More...

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)

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

RTM::ManagerServant::ManagerServant ( )

Constructor.

Constructor

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

virtual

Virtual destructor.

Member Function Documentation

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

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

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

Getting a slave manager.

This operation add a slave manager to this manager.

Parameters

mgr	A slave manager

Returns: ReturnCode_t

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

Creating an RT-Component.

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

Returns: A created RT-Component

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

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

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

bool RTM::ManagerServant::createINSManager ( )

Generate INSManager.

成功:true, 失敗:false

Returns: Successful:true, Failed:false

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

Deleting an RT-Component.

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

Returns: Return code

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

Find the reference of Manager.

Returns: Manager reference

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

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

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

The copy of the process is generated.

Returns: ReturnCode_t

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

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

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

Getting RT-Component list running on this manager.

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

Returns: A list of RT-Components

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

Parameters

name name

Returns: list of RTC

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

Getting this manager's configuration.

This operation returns this manager's configuration.

Returns: Manager's configuration

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

Getting component factory profiles.

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

Returns: An RT-Component factory profile list.

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

Getting loadable module profiles.

This operation returns loadable module profiles.

Returns: A module profile list.

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

Getting loaded module profiles.

This operation returns loaded module profiles.

Returns: A module profile list.

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

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

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

Getting this manager's profile.

This operation returns this manager's profile.

Returns: Manager's profile

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

Get the reference of RTC.

Returns: RTC reference

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

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

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

Get the reference of Manager.

Returns: Manager reference

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

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

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.

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

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

Loading a module.

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.

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

Removing a master manager.

This operation removes a master manager from this manager.

Parameters

mgr	A master manager

Returns: ReturnCode_t

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

Removing a slave manager.

This operation removes a slave manager from this manager.

Parameters

mgr	A slave manager

Returns: ReturnCode_t

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

This method restarts RTC.

Returns: ReturnCode_t

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

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

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

This method shutdowns RTC.

Returns: ReturnCode_t

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

Unloading a module.

This operation unloads a specified loadable module.

Parameters

pathname A path to a loading module.

Returns: The return code.

void RTM::ManagerServant::updateMasterManager ( )

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

ManagerServant.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation