OpenRTM-aist
1.2.1
|
#include <PortAdmin.h>
Public Member Functions | |
PortAdmin (CORBA::ORB_ptr orb, PortableServer::POA_ptr poa) | |
Constructor. More... | |
virtual | ~PortAdmin (void) |
Destructor. More... | |
PortServiceList * | getPortServiceList () const |
Get PortServiceList. More... | |
PortProfileList | getPortProfileList () const |
Get PorProfileList. More... | |
PortService_ptr | getPortRef (const char *port_name) const |
Get the reference to Port object. More... | |
PortBase * | getPort (const char *port_name) const |
Get pointer to the Port's servant. More... | |
bool | addPort (PortBase &port) |
Regsiter the Port. More... | |
bool | addPort (PortService_ptr port) |
Regsiter the Port. 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... | |
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 | activatePorts () |
Activate all Port interfaces. More... | |
void | deactivatePorts () |
Deactivate all Port interfaces. More... | |
void | finalizePorts () |
Deactivate all Ports and unregister them. More... | |
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.
RTC::PortAdmin::PortAdmin | ( | CORBA::ORB_ptr | orb, |
PortableServer::POA_ptr | poa | ||
) |
Constructor.
Constructor
orb | ORB |
poa | POA |
|
inlinevirtual |
Destructor.
Destructor
References activatePorts(), addPort(), deactivatePorts(), deletePort(), deletePortByName(), finalizePorts(), getPort(), RTC::PortBase::getPortProfile(), getPortProfileList(), getPortRef(), getPortServiceList(), CORBA_SeqUtil::push_back(), registerPort(), and removePort().
void RTC::PortAdmin::activatePorts | ( | ) |
Activate all Port interfaces.
This operation activate all interfaces that is registered in the ports.
Referenced by ~PortAdmin().
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.
port | The Port's servant. |
Referenced by ~PortAdmin().
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.
port | The Port's servant. |
void RTC::PortAdmin::deactivatePorts | ( | ) |
Deactivate all Port interfaces.
This operation deactivate all interfaces that is registered in the ports.
Referenced by ~PortAdmin().
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.
port | The Port's servant. |
Referenced by ~PortAdmin().
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.
port | The Port's servant. |
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.
port_name | The Port's name. |
Referenced by ~PortAdmin().
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.
Referenced by ~PortAdmin().
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().
port_name | The name of Port to be returned the servant pointer. |
Referenced by ~PortAdmin().
PortProfileList RTC::PortAdmin::getPortProfileList | ( | ) | const |
Get PorProfileList.
This operation gets the Profile list of Ports registered by addPort().
Referenced by ~PortAdmin().
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 addPort().
port_name | The name of Port to be returned the reference. |
Referenced by ~PortAdmin().
PortServiceList* RTC::PortAdmin::getPortServiceList | ( | ) | const |
Get PortServiceList.
This operation returns the pointer to the PortServiceList of Ports registered by addPort().
Referenced by ~PortAdmin().
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.
port | The Port's servant. |
Referenced by ~PortAdmin().
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.
port | The Port's servant. |
bool RTC::PortAdmin::removePort | ( | 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.
port | The Port's servant. |
Referenced by ~PortAdmin().
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.
port | The Port's servant. |