Classes | Public Member Functions | Private Attributes | List of all members
RTC::PortAdmin Class Reference

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

Private Attributes

CORBA::ORB_var m_pORB
 Reference to ORB. More...
 
PortServiceList m_portRefs
 List of Port's object references. More...
 
ObjectManager< const char *, PortBase, comp_op< PortBase > > m_portServants
 
PortableServer::POA_var m_pPOA
 Reference to POA. More...
 
Logger rtclog
 Logger stream. More...
 

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

◆ PortAdmin()

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

Constructor.

Constructor

Parameters
orbORB
poaPOA

Definition at line 94 of file PortAdmin.cpp.

◆ ~PortAdmin()

virtual RTC::PortAdmin::~PortAdmin ( void  )
inlinevirtual

Destructor.

Destructor

Definition at line 89 of file PortAdmin.h.

Member Function Documentation

◆ activatePorts()

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.

◆ addPort() [1/2]

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
portThe Port's servant.
Returns
Register result (Successful:true, Failed:false)

Definition at line 191 of file PortAdmin.cpp.

◆ addPort() [2/2]

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
portThe Port's servant.
Returns
Register result (Successful:true, Failed:false)

Definition at line 214 of file PortAdmin.cpp.

◆ deactivatePorts()

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.

◆ deletePort() [1/2]

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
portThe Port's servant.

Definition at line 297 of file PortAdmin.cpp.

◆ deletePort() [2/2]

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
portThe Port's servant.

Definition at line 304 of file PortAdmin.cpp.

◆ deletePortByName()

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_nameThe Port's name.

Definition at line 320 of file PortAdmin.cpp.

◆ finalizePorts()

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.

◆ getPort()

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

◆ getPortProfileList()

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.

◆ getPortRef()

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_nameThe name of Port to be returned the reference.
Returns
PortService_ptr Port object reference.

Definition at line 161 of file PortAdmin.cpp.

◆ getPortServiceList()

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.

◆ registerPort() [1/2]

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
portThe Port's servant.

Definition at line 239 of file PortAdmin.cpp.

◆ registerPort() [2/2]

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
portThe Port's servant.

Definition at line 247 of file PortAdmin.cpp.

◆ removePort() [1/2]

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
portThe Port's servant.
Returns
Unregister result (Successful:true, Failed:false)

Definition at line 262 of file PortAdmin.cpp.

◆ removePort() [2/2]

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
portThe Port's servant.
Returns
Unregister result (Successful:true, Failed:false)

Definition at line 284 of file PortAdmin.cpp.

Member Data Documentation

◆ m_pORB

CORBA::ORB_var RTC::PortAdmin::m_pORB
private

Reference to ORB.

Definition at line 496 of file PortAdmin.h.

◆ m_portRefs

PortServiceList RTC::PortAdmin::m_portRefs
private

List of Port's object references.

Definition at line 514 of file PortAdmin.h.

◆ m_portServants

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

Definition at line 595 of file PortAdmin.h.

◆ m_pPOA

PortableServer::POA_var RTC::PortAdmin::m_pPOA
private

Reference to POA.

Definition at line 505 of file PortAdmin.h.

◆ rtclog

Logger RTC::PortAdmin::rtclog
mutableprivate

Logger stream.

Definition at line 523 of file PortAdmin.h.


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


openrtm_aist
Author(s): Noriaki Ando
autogenerated on Mon Feb 28 2022 23:00:47