Manager CORBA class. More...

#include <ManagerServant.h>

Classes
class	is_equiv
	Functor to inspect if Manster_var is equivalent. More...
Public Member Functions
RTC::ReturnCode_t	add_master_manager (RTM::Manager_ptr mgr)
	Getting a master manager.
RTC::ReturnCode_t	add_slave_manager (RTM::Manager_ptr mgr)
	Getting a slave manager.
RTC::RTObject_ptr	create_component (const char *module_name)
	Creating an RT-Component.
bool	createINSManager ()
	Generate INSManager.
RTC::ReturnCode_t	delete_component (const char *instance_name)
	Deleting an RT-Component.
RTM::Manager_ptr	findManager (const char *host_port)
	Find the reference of Manager.
RTC::ReturnCode_t	fork ()
	The copy of the process is generated.
RTC::ComponentProfileList *	get_component_profiles ()
	Getting RT-Component's profile list running on this manager.
RTC::RTCList *	get_components ()
	Getting RT-Component list running on this manager.
RTM::NVList *	get_configuration ()
	Getting this manager's configuration.
RTM::ModuleProfileList *	get_factory_profiles ()
	Getting component factory profiles.
RTM::ModuleProfileList *	get_loadable_modules ()
	Getting loadable module profiles.
RTM::ModuleProfileList *	get_loaded_modules ()
	Getting loaded module profiles.
RTM::ManagerList *	get_master_managers ()
	Getting master managers.
RTM::ManagerProfile *	get_profile ()
	Getting this manager's profile.
CORBA::Object_ptr	get_service (const char *name)
	Get the reference of RTC.
RTM::ManagerList *	get_slave_managers ()
	Getting slave managers.
RTM::Manager_ptr	getObjRef () const
	Get the reference of Manager.
::CORBA::Boolean	is_master ()
	Whether this manager is master or not.
RTC::ReturnCode_t	load_module (const char pathname, const char initfunc)
	Loading a module.
	ManagerServant ()
	Constructor.
RTC::ReturnCode_t	remove_master_manager (RTM::Manager_ptr mgr)
	Removing a master manager.
RTC::ReturnCode_t	remove_slave_manager (RTM::Manager_ptr mgr)
	Removing a slave manager.
RTC::ReturnCode_t	restart ()
	This method restarts RTC.
RTC::ReturnCode_t	set_configuration (const char name, const char value)
	Setting manager's configuration.
RTC::ReturnCode_t	shutdown ()
	This method shutdowns RTC.
RTC::ReturnCode_t	unload_module (const char *pathname)
	Unloading a module.
virtual	~ManagerServant (void)
	Virtual destructor.
Private Types
typedef coil::Guard< coil::Mutex >	Guard
Private Attributes
CORBA::Boolean	m_isMaster
	Flag if this is master.
::coil::Mutex	m_masterMutex
	Mutex of m_masters.
::RTM::ManagerList	m_masters
	List of master managers.
::RTC::Manager &	m_mgr
	Reference to the RTC::Manager.
::RTM::Manager_var	m_objref
	An object reference of ManagerServant.
::coil::Mutex	m_slaveMutex
	Mutex of m_slaves.
::RTM::ManagerList	m_slaves
	List of slave managers.
::RTC::Logger	rtclog
	Logger object.

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.

Definition at line 63 of file ManagerServant.h.

Member Typedef Documentation

typedef coil::Guard<coil::Mutex> RTM::ManagerServant::Guard [private]

Definition at line 579 of file ManagerServant.h.

Constructor & Destructor Documentation

RTM::ManagerServant::ManagerServant ( )

Constructor.

Constructor

Definition at line 32 of file ManagerServant.cpp.

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

Virtual destructor.

Definition at line 80 of file ManagerServant.cpp.

Member Function Documentation

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

Getting a master manager.

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

Definition at line 620 of file ManagerServant.cpp.

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

Getting a slave manager.

Getting a slave manager .

This operation add a slave manager to this manager.

Parameters:

mgr	A slave manager

Returns:: ReturnCode_t

Definition at line 687 of file ManagerServant.cpp.

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

Creating an RT-Component.

Creating an RT-Component .

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

Returns:: A created RT-Component

Definition at line 318 of file ManagerServant.cpp.

bool RTM::ManagerServant::createINSManager ( )

Generate INSManager.

��:true, ��:false

Returns:: Successful:true, Failed:false

Definition at line 762 of file ManagerServant.cpp.

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

Deleting an RT-Component.

Deleting an RT-Component .

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

Returns:: Return code

Definition at line 426 of file ManagerServant.cpp.

RTM::Manager_ptr RTM::ManagerServant::findManager ( const char * host_port )

Find the reference of Manager.

Returns:: Manager reference

Definition at line 809 of file ManagerServant.cpp.

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

The copy of the process is generated.

Returns:: ReturnCode_t

Definition at line 733 of file ManagerServant.cpp.

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

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

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

Definition at line 490 of file ManagerServant.cpp.

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

Getting RT-Component list running on this manager.

Getting RT-Component list running on this manager .

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

Returns:: A list of RT-Components

Definition at line 441 of file ManagerServant.cpp.

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

Getting this manager's configuration.

Getting this manager's configuration. .

This operation returns this manager's configuration.

Returns:: Manager's configuration

Definition at line 557 of file ManagerServant.cpp.

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

Getting component 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.

Definition at line 264 of file ManagerServant.cpp.

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

Getting loadable module profiles.

Getting loadable module profiles .

This operation returns loadable module profiles.

Returns:: A module profile list.

Definition at line 156 of file ManagerServant.cpp.

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

Getting loaded module profiles.

Getting loaded module profiles .

This operation returns loaded module profiles.

Returns:: A module profile list.

Definition at line 210 of file ManagerServant.cpp.

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

Getting 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

Definition at line 606 of file ManagerServant.cpp.

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

Getting this manager's profile.

Getting this manager's profile. .

This operation returns this manager's profile.

Returns:: Manager's profile

Definition at line 541 of file ManagerServant.cpp.

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

Get the reference of RTC.

Returns:: RTC reference

Definition at line 751 of file ManagerServant.cpp.

ManagerList * RTM::ManagerServant::get_slave_managers ( )

Getting 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

Definition at line 672 of file ManagerServant.cpp.

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

Get the reference of Manager.

Returns:: Manager reference

Definition at line 756 of file ManagerServant.cpp.

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

Whether this manager is master or not.

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.

Definition at line 593 of file ManagerServant.cpp.

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

Loading a module.

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.

Definition at line 124 of file ManagerServant.cpp.

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

Removing a master manager.

Removing a master manager .

This operation removes a master manager from this manager.

Parameters:

mgr	A master manager

Returns:: ReturnCode_t

Definition at line 646 of file ManagerServant.cpp.

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

Removing a slave manager.

Removing a slave manager .

This operation removes a slave manager from this manager.

Parameters:

mgr	A slave manager

Returns:: ReturnCode_t

Definition at line 713 of file ManagerServant.cpp.

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

This method restarts RTC.

Returns:: ReturnCode_t

Definition at line 745 of file ManagerServant.cpp.

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

Setting manager's configuration.

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

Definition at line 580 of file ManagerServant.cpp.

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

This method shutdowns RTC.

Returns:: ReturnCode_t

Definition at line 739 of file ManagerServant.cpp.

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

Unloading a module.

Unloading a module .

This operation unloads a specified loadable module.

Parameters:

pathname A path to a loading module.

Returns:: The return code.

Definition at line 140 of file ManagerServant.cpp.

Member Data Documentation

CORBA::Boolean RTM::ManagerServant::m_isMaster [private]

Flag if this is master.

Definition at line 650 of file ManagerServant.h.

::coil::Mutex RTM::ManagerServant::m_masterMutex [private]

Mutex of m_masters.

Definition at line 623 of file ManagerServant.h.

::RTM::ManagerList RTM::ManagerServant::m_masters [private]

List of master managers.

Definition at line 614 of file ManagerServant.h.

::RTC::Manager& RTM::ManagerServant::m_mgr [private]

Reference to the RTC::Manager.

Definition at line 596 of file ManagerServant.h.

::RTM::Manager_var RTM::ManagerServant::m_objref [private]

An object reference of ManagerServant.

Definition at line 605 of file ManagerServant.h.

::coil::Mutex RTM::ManagerServant::m_slaveMutex [private]

Mutex of m_slaves.

Definition at line 641 of file ManagerServant.h.

::RTM::ManagerList RTM::ManagerServant::m_slaves [private]

List of slave managers.

Definition at line 632 of file ManagerServant.h.

::RTC::Logger RTM::ManagerServant::rtclog [private]

Logger object.

Definition at line 587 of file ManagerServant.h.

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

Classes

Public Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation