RTC::PortAdmin Class Reference

PortAdmin class. More...

#include <PortAdmin.h>

List of all members.

Public Member Functions

 PortAdmin (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa)
 Constructor.
virtual ~PortAdmin (void)
 Destructor.
PortServiceList * getPortServiceList () const
 Get PortServiceList.
PortProfileList getPortProfileList () const
 Get PorProfileList.
PortService_ptr getPortRef (const char *port_name) const
 Get the reference to Port object.
PortBasegetPort (const char *port_name) const
 Get pointer to the Port's servant.
void registerPort (PortBase &port)
 Regsiter the Port.
void registerPort (PortService_ptr port)
void deletePort (PortBase &port)
 Unregister the Port registration.
void deletePort (PortService_ptr port)
void deletePortByName (const char *port_name)
 Unregister the Port's registration by its name.
void activatePorts ()
 Activate all Port interfaces.
void deactivatePorts ()
 Deactivate all Port interfaces.
void finalizePorts ()
 Deactivate all Ports and unregister them.

Classes

class  comp_op
class  port_prof_collect
class  port_prof_collect2


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

Constructor & Destructor Documentation

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

Constructor.

Constructor

Parameters:
orb ORB
poa POA

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

Destructor.

Destructor


Member Function Documentation

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

Get PortServiceList.

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

Returns:
The pointer points PortServiceList

PortProfileList RTC::PortAdmin::getPortProfileList (  )  const

Get PorProfileList.

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

Returns:
The pointer points PortProfile list

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

Get the reference to Port object.

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

Parameters:
port_name The name of Port to be returned the reference.
Returns:
PortService_ptr Port object reference.

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 registerPort(). The port specified by port_name must be already registered in registerPort().

Parameters:
port_name The name of Port to be returned the servant pointer.
Returns:
PortBase* The pointer to Port's servant.

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.

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

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.

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

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.

void RTC::PortAdmin::activatePorts (  ) 

Activate all Port interfaces.

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

void RTC::PortAdmin::deactivatePorts (  ) 

Deactivate all Port interfaces.

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

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.


Generated on Sun May 24 14:08:45 2009 for OpenRTM by  doxygen 1.5.3