PortAdmin class. More...

#include <PortAdmin.h>

Classes
class	comp_op
	comp_op functor More...
struct	del_port
	Functor to delete the Port. More...
struct	find_port
struct	find_port_name
	Functor to fing a Port. More...
class	port_prof_collect
	PortProfileList corerection functor. More...
class	port_prof_collect2
	PortProfileList corerection functor. More...
Public Member Functions
void	activatePorts ()
	Activate all Port interfaces.
bool	addPort (PortBase &port)
	Regsiter the Port.
bool	addPort (PortService_ptr port)
	Regsiter the Port.
void	deactivatePorts ()
	Deactivate all Port interfaces.
void	deletePort (PortBase &port)
	Unregister the Port registration.
void	deletePort (PortService_ptr port)
	Unregister the Port registration.
void	deletePortByName (const char *port_name)
	Unregister the Port's registration by its name.
void	finalizePorts ()
	Deactivate all Ports and unregister them.
PortBase *	getPort (const char *port_name) const
	Get pointer to the Port's servant.
PortProfileList	getPortProfileList () const
	Get PorProfileList.
PortService_ptr	getPortRef (const char *port_name) const
	Get the reference to Port object.
PortServiceList *	getPortServiceList () const
	Get PortServiceList.
	PortAdmin (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa)
	Constructor.
void	registerPort (PortBase &port)
	Regsiter the Port.
void	registerPort (PortService_ptr port)
	Regsiter the Port.
bool	removePort (PortBase &port)
	Unregister the Port registration.
bool	removePort (PortService_ptr port)
	Unregister the Port registration.
virtual	~PortAdmin (void)
	Destructor.
Private Attributes
CORBA::ORB_var	m_pORB
	Reference to ORB.
PortServiceList	m_portRefs
	List of Port's object references.
ObjectManager< const char *, PortBase, comp_op< PortBase > >	m_portServants
PortableServer::POA_var	m_pPOA
	Reference to POA.
Logger	rtclog
	Logger stream.

Detailed Description

PortAdmin class.

This is a class to manage various Ports. It executes various management operations such as registering and unregistering Port etc and also manages registered ports.

Since:: 0.4.0

Definition at line 52 of file PortAdmin.h.

Constructor & Destructor Documentation

RTC::PortAdmin::PortAdmin	(	CORBA::ORB_ptr	orb,
		PortableServer::POA_ptr	poa
	)

Constructor.

Constructor

Parameters:

orb	ORB
poa	POA

Definition at line 94 of file PortAdmin.cpp.

virtual RTC::PortAdmin::~PortAdmin ( void ) [inline, virtual]

Destructor.

Destructor

Definition at line 89 of file PortAdmin.h.

Member Function Documentation

void RTC::PortAdmin::activatePorts ( )

Activate all Port interfaces.

This operation activate all interfaces that is registered in the ports.

Definition at line 334 of file PortAdmin.cpp.

bool RTC::PortAdmin::addPort ( PortBase & port )

Regsiter the Port.

This operation registers the Port's servant given by argument. The given Port's servant will be activated on the POA that is given to the constructor, and the created object reference is set to the Port's profile.

Parameters:

port	The Port's servant.

Returns:: Register result (Successful:true, Failed:false)

Definition at line 191 of file PortAdmin.cpp.

bool RTC::PortAdmin::addPort ( PortService_ptr port )

Regsiter the Port.

This operation registers the Port's servant given by argument. The given Port's servant will be activated on the POA that is given to the constructor, and the created object reference is set to the Port's profile.

Parameters:

port	The Port's servant.

Returns:: Register result (Successful:true, Failed:false)

Definition at line 214 of file PortAdmin.cpp.

void RTC::PortAdmin::deactivatePorts ( )

Deactivate all Port interfaces.

This operation deactivate all interfaces that is registered in the ports.

Definition at line 351 of file PortAdmin.cpp.

void RTC::PortAdmin::deletePort ( PortBase & port )

Unregister the Port registration.

This operation unregisters the Port registration. When the Port is unregistered, Port is deactivated, and the object reference in the Port's profile is set to nil.

Parameters:

port	The Port's servant.

Definition at line 297 of file PortAdmin.cpp.

void RTC::PortAdmin::deletePort ( PortService_ptr port )

Unregister the Port registration.

This operation unregisters the Port registration. When the Port is unregistered, Port is deactivated, and the object reference in the Port's profile is set to nil.

Parameters:

port	The Port's servant.

Definition at line 304 of file PortAdmin.cpp.

void RTC::PortAdmin::deletePortByName ( const char * port_name )

Unregister the Port's registration by its name.

This operation unregister the Port's registration specified by port_ name. When the Port is unregistered, Port is deactivated, and the object reference in the Port's profile is set to nil.

Parameters:

port_name The Port's name.

Definition at line 320 of file PortAdmin.cpp.

void RTC::PortAdmin::finalizePorts ( )

Deactivate all Ports and unregister them.

This operation deactivates the all Port and deletes the all Port's registrations from the list.

Definition at line 368 of file PortAdmin.cpp.

PortBase * RTC::PortAdmin::getPort ( const char * port_name ) const

Get pointer to the Port's servant.

This operation returns the pointer to the PortBase servant registered by addPort(). The port specified by port_name must be already registered in addPort().

Parameters:

port_name The name of Port to be returned the servant pointer.

Returns:: PortBase* The pointer to Port's servant.

Definition at line 179 of file PortAdmin.cpp.

PortProfileList RTC::PortAdmin::getPortProfileList ( ) const

Get PorProfileList.

Get PortProfileList.

This operation gets the Profile list of Ports registered by addPort().

Returns:: The pointer points PortProfile list

Definition at line 122 of file PortAdmin.cpp.

PortService_ptr RTC::PortAdmin::getPortRef ( const char * port_name ) const

Get the reference to Port object.

Get the reference to the Port's object.

This operation returns the reference of Port object specified by port_name. The port specified by port_name must be already registered in addPort().

Parameters:

port_name The name of Port to be returned the reference.

Returns:: PortService_ptr Port object reference.

Definition at line 161 of file PortAdmin.cpp.

PortServiceList * RTC::PortAdmin::getPortServiceList ( ) const

Get PortServiceList.

This operation returns the pointer to the PortServiceList of Ports registered by addPort().

Returns:: The pointer points PortServiceList

Definition at line 108 of file PortAdmin.cpp.

void RTC::PortAdmin::registerPort ( PortBase & port )

Regsiter the Port.

This operation registers the Port's servant given by argument. The given Port's servant will be activated on the POA that is given to the constructor, and the created object reference is set to the Port's profile.

Parameters:

port	The Port's servant.

Definition at line 239 of file PortAdmin.cpp.

void RTC::PortAdmin::registerPort ( PortService_ptr port )

Regsiter the Port.

This operation registers the Port's servant given by argument. The given Port's servant will be activated on the POA that is given to the constructor, and the created object reference is set to the Port's profile.

Parameters:

port	The Port's servant.

Definition at line 247 of file PortAdmin.cpp.

bool RTC::PortAdmin::removePort ( PortBase & port )

Unregister the Port registration.

Unregister the Port's registration.

This operation unregisters the Port registration. When the Port is unregistered, Port is deactivated, and the object reference in the Port's profile is set to nil.

Parameters:

port	The Port's servant.

Returns:: Unregister result (Successful:true, Failed:false)

Definition at line 262 of file PortAdmin.cpp.

bool RTC::PortAdmin::removePort ( PortService_ptr port )

Unregister the Port registration.

This operation unregisters the Port registration. When the Port is unregistered, Port is deactivated, and the object reference in the Port's profile is set to nil.

Parameters:

port	The Port's servant.

Returns:: Unregister result (Successful:true, Failed:false)

Definition at line 284 of file PortAdmin.cpp.

Member Data Documentation

CORBA::ORB_var RTC::PortAdmin::m_pORB [private]

Reference to ORB.

Definition at line 496 of file PortAdmin.h.

PortServiceList RTC::PortAdmin::m_portRefs [private]

List of Port's object references.

Definition at line 514 of file PortAdmin.h.

ObjectManager<const char*, PortBase, comp_op<PortBase> > RTC::PortAdmin::m_portServants [private]

Definition at line 595 of file PortAdmin.h.

PortableServer::POA_var RTC::PortAdmin::m_pPOA [private]

Reference to POA.

Definition at line 505 of file PortAdmin.h.

Logger RTC::PortAdmin::rtclog [mutable, private]

Logger stream.

Definition at line 523 of file PortAdmin.h.

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

Classes

Public Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation