Classes | Public Member Functions | Private Attributes
OpenRTM_aist.PortAdmin.PortAdmin Class Reference

PortAdmin class. More...

List of all members.

Classes

class  comp_op
class  del_port
 Functor to delete the Port. More...
class  find_port
class  find_port_name

Public Member Functions

def __init__
 Constructor.
def activatePorts
 Activate all Port interfaces void PortAdmin::activatePorts()
def addPort
def deactivatePorts
 Deactivate all Port interfaces void PortAdmin::deactivatePorts()
def deletePort
 Delete the Port's registration.
def deletePortByName
 Delete the Port' registration.
def finalizePorts
 Unregister the Port.
def getPort
 Getpointer to the Port's servant.
def getPortProfileList
 Get PorProfileList.
def getPortRef
 Get PortServiceList.
def getPortServiceList
 Get PortServiceList.
def registerPort
 Regsiter Port.
def removePort

Private Attributes

 _orb
 _poa
 _portRefs
 _portServants
 _rtcout

Detailed Description

PortAdmin class.

Definition at line 41 of file PortAdmin.py.


Constructor & Destructor Documentation

def OpenRTM_aist.PortAdmin.PortAdmin.__init__ (   self,
  orb,
  poa 
)

Constructor.

Definition at line 120 of file PortAdmin.py.


Member Function Documentation

Activate all Port interfaces void PortAdmin::activatePorts()

Definition at line 400 of file PortAdmin.py.

def OpenRTM_aist.PortAdmin.PortAdmin.addPort (   self,
  port 
)

Definition at line 288 of file PortAdmin.py.

Deactivate all Port interfaces void PortAdmin::deactivatePorts()

Definition at line 415 of file PortAdmin.py.

def OpenRTM_aist.PortAdmin.PortAdmin.deletePort (   self,
  port 
)

Delete the Port's registration.

This operation unregisters the Port's 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 334 of file PortAdmin.py.

def OpenRTM_aist.PortAdmin.PortAdmin.deletePortByName (   self,
  port_name 
)

Delete the Port' registration.

This operation delete 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 384 of file PortAdmin.py.

Unregister the Port.

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

Definition at line 441 of file PortAdmin.py.

def OpenRTM_aist.PortAdmin.PortAdmin.getPort (   self,
  port_name 
)

Getpointer to the Port's servant.

This operation returns the pointer to the PortBase servant regsitered by registerPort().

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

Definition at line 247 of file PortAdmin.py.

Get PorProfileList.

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

Returns:
The pointer points PortProfile list

Definition at line 180 of file PortAdmin.py.

def OpenRTM_aist.PortAdmin.PortAdmin.getPortRef (   self,
  port_name 
)

Get PortServiceList.

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

Parameters:
port_nameThe name of Port to be returned the reference.
Returns:
Port_ptr Port's object reference.

Definition at line 214 of file PortAdmin.py.

Get PortServiceList.

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

Returns:
PortServiceList+ The pointer points PortServiceList

Definition at line 156 of file PortAdmin.py.

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

void registerPort(PortBase& port);

Definition at line 276 of file PortAdmin.py.

def OpenRTM_aist.PortAdmin.PortAdmin.removePort (   self,
  port 
)

Definition at line 340 of file PortAdmin.py.


Member Data Documentation

Definition at line 120 of file PortAdmin.py.

Definition at line 120 of file PortAdmin.py.

Definition at line 120 of file PortAdmin.py.

Definition at line 120 of file PortAdmin.py.

Definition at line 120 of file PortAdmin.py.


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


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Thu Aug 27 2015 14:17:29