OpenRTM-aist-Python 1.1.2
Classes | Public Member Functions | List of all members
OpenRTM_aist.OutPortBase.OutPortBase Class Reference

Output base class. More...

Inheritance diagram for OpenRTM_aist.OutPortBase.OutPortBase:
OpenRTM_aist.PortBase.PortBase OpenRTM_aist.DataPortStatus.DataPortStatus OpenRTM_aist.OutPort.OutPort

Classes

class  connector_cleanup
 Functor to delete Connectors. More...
 
class  provider_cleanup
 Functor to delete Providers. More...
 

Public Member Functions

def __init__
 A constructor of OutPortBase class. More...
 
def __del__
 destructor More...
 
def init
 Initializing properties. More...
 
def write
 Write data. More...
 
def connect
 [CORBA interface] Connect the Port More...
 
def properties
 Get properties. More...
 
def connectors
 Connector listconst std::vector<OutPortConnector*>& OutPortBase::connectors()
 
def getConnectorProfiles
 ConnectorProfile listConnectorBase::ConnectorInfoList OutPortBase::getConnectorProfiles()
 
def getConnectorIds
 ConnectorId listcoil::vstring OutPortBase::getConnectorIds()
 
def getConnectorNames
 Connector name listcoil::vstring OutPortBase::getConnectorNames()
 
def getConnectorById
 Getting ConnectorProfile by ID. More...
 
def getConnectorByName
 Getting Connector by name. More...
 
def getConnectorProfileById
 Getting ConnectorProfile by namebool OutPortBase::getConnectorProfileById(const char* id, ConnectorInfo& prof)
 
def getConnectorProfileByName
 Getting ConnectorProfile by namebool OutPortBase::getConnectorProfileByName(const char* name, ConnectorInfo& prof)
 
def activateInterfaces
 Activate all Port interfacesvoid OutPortBase::activateInterfaces()
 
def deactivateInterfaces
 Deactivate all Port interfacesvoid OutPortBase::deactivateInterfaces()
 
def addConnectorDataListener
 Adding BufferDataListener type listener. More...
 
def removeConnectorDataListener
 Removing BufferDataListener type listener. More...
 
def addConnectorListener
 Adding ConnectorListener type listener. More...
 
def removeConnectorListener
 Removing BufferDataListener type listener. More...
 
def configure
 Configureing outportvoid OutPortBase::configure()
 
def publishInterfaces
 Publish interface informationReturnCode_t OutPortBase::publishInterfaces(ConnectorProfile& cprof)
 
def subscribeInterfaces
 Subscribe interfaceReturnCode_t OutPortBase::subscribeInterfaces(const ConnectorProfile& cprof)
 
def unsubscribeInterfaces
 Unsubscribe interfacevoid OutPortBase::unsubscribeInterfaces(const ConnectorProfile& connector_profile)
 
def initProviders
 OutPort provider initializationvoid OutPortBase::initProviders()
 
def initConsumers
 InPort consumer initializationvoid OutPortBase::initConsumers()
 
def createProvider
 OutPort provider creationOutPortProvider* OutPortBase::createProvider(ConnectorProfile& cprof, coil::Properties& prop)
 
def createConsumer
 InPort consumer creationInPortConsumer* OutPortBase::createConsumer(const ConnectorProfile& cprof, coil::Properties& prop)
 
def createConnector
 OutPortPushConnector creationOutPortConnector* OutPortBase::createConnector(const ConnectorProfile& cprof, coil::Properties& prop, InPortConsumer* consumer)
 
- Public Member Functions inherited from OpenRTM_aist.PortBase.PortBase
def __init__
 Constructor. More...
 
def __del__
 Destructor. More...
 
def get_port_profile
 [CORBA interface] Get the PortProfile of the Port More...
 
def getPortProfile
 Get the PortProfile of the Port. More...
 
def get_connector_profiles
 [CORBA interface] Get the ConnectorProfileList of the Port More...
 
def get_connector_profile
 [CORBA interface] Get the ConnectorProfile More...
 
def connect
 [CORBA interface] Connect the Port More...
 
def notify_connect
 [CORBA interface] Notify the Ports connection More...
 
def disconnect
 [CORBA interface] Disconnect the Port More...
 
def notify_disconnect
 [CORBA interface] Notify the Ports disconnection More...
 
def disconnect_all
 [CORBA interface] Connect the Port More...
 
def setName
 Set the name of this Port. More...
 
def getName
 Get the name of this Port. More...
 
def getProfile
 Get the PortProfile of the Port. More...
 
def setPortRef
 Set the object reference of this Port. More...
 
def getPortRef
 Get the object reference of this Port. More...
 
def setOwner
 Set the owner RTObject of the Port. More...
 
def setOnPublishInterfaces
 Setting callback called on publish interfaces. More...
 
def setOnSubscribeInterfaces
 Setting callback called on publish interfaces. More...
 
def setOnConnected
 Setting callback called on connection established. More...
 
def setOnUnsubscribeInterfaces
 Setting callback called on unsubscribe interfaces. More...
 
def setOnDisconnected
 Setting callback called on disconnected. More...
 
def setPortConnectListenerHolder
 Setting PortConnectListener holder. More...
 
def publishInterfaces
 Publish interface information. More...
 
def connectNext
 Call notify_connect() of the next Port. More...
 
def disconnectNext
 Call notify_disconnect() of the next Port. More...
 
def subscribeInterfaces
 Publish interface information. More...
 
def unsubscribeInterfaces
 Disconnect interface connection. More...
 
def setConnectionLimit
 Set the maximum number of connections. More...
 
def isEmptyId
 Whether connector_id of ConnectorProfile is empty. More...
 
def getUUID
 Get the UUID. More...
 
def setUUID
 Create and set the UUID to the ConnectorProfile. More...
 
def isExistingConnId
 Whether the given id exists in stored ConnectorProfiles. More...
 
def findConnProfile
 Find ConnectorProfile with id. More...
 
def findConnProfileIndex
 Find ConnectorProfile with id. More...
 
def updateConnectorProfile
 Append or update the ConnectorProfile list. More...
 
def eraseConnectorProfile
 Delete the ConnectorProfile. More...
 
def appendInterface
 Append an interface to the PortInterfaceProfile. More...
 
def deleteInterface
 Delete an interface from the PortInterfaceProfile. More...
 
def addProperty
 Add NameValue data to PortProfile's properties. More...
 
def appendProperty
 Append NameValue data to PortProfile's properties. More...
 
def updateConnectors
 Disconnect ports that doesn't exist. More...
 
def checkPorts
 Existence of ports. More...
 
- Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def toString
 Convert DataPortStatus into the string. More...
 

Additional Inherited Members

- Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int PORT_OK = 0
 DataPortStatus return codes. More...
 

Detailed Description

Output base class.

The base class of OutPort<T> which are implementations of OutPort

Form a kind of Observer pattern with OutPortBase and PublisherBase. attach(), detach(), notify() of OutPortBase and push() of PublisherBase are methods associated with the Observer pattern.

Since
0.2.0

Constructor & Destructor Documentation

def OpenRTM_aist.OutPortBase.OutPortBase.__init__ (   self,
  name,
  data_type 
)

A constructor of OutPortBase class.

Constructor of OutPortBase.

OutPortBase::OutPortBase(const char* name, const char* data_type)

def OpenRTM_aist.OutPortBase.OutPortBase.__del__ (   self,
  PortBase = OpenRTM_aist.PortBase 
)

destructor

Destructor

Member Function Documentation

def OpenRTM_aist.OutPortBase.OutPortBase.addConnectorDataListener (   self,
  listener_type,
  listener,
  autoclean = True 
)

Adding BufferDataListener type listener.

This operation adds certain listeners related to buffer writing and reading events. The following listener types are available.

  • ON_BUFFER_WRITE: At the time of buffer write
  • ON_BUFFER_FULL: At the time of buffer full
  • ON_BUFFER_WRITE_TIMEOUT: At the time of buffer write timeout
  • ON_BUFFER_OVERWRITE: At the time of buffer overwrite
  • ON_BUFFER_READ: At the time of buffer read
  • ON_SEND: At the time of sending to InPort
  • ON_RECEIVED: At the time of finishing sending to InPort
  • ON_SENDER_TIMEOUT: At the time of timeout of OutPort
  • ON_SENDER_ERROR: At the time of error of OutPort
  • ON_RECEIVER_FULL: At the time of bufferfull of InPort
  • ON_RECEIVER_TIMEOUT: At the time of timeout of InPort
  • ON_RECEIVER_ERROR: At the time of error of InPort

Listeners should have the following function operator().

ConnectorDataListener:: operator()(const ConnectorProfile&, const cdrStream&)

The ownership of the given listener object is transferred to this OutPort object in default. The given listener object will be destroied automatically in the OutPort's dtor or if the listener is deleted by removeConnectorDataListener() function. If you want to keep ownership of the listener object, give "false" value to 3rd argument to inhibit automatic destruction.

Parameters
listener_typeA listener type
listenerA pointer to a listener object
autocleanA flag for automatic listener destruction

void addConnectorDataListener(ConnectorDataListenerType listener_type, ConnectorDataListener* listener, bool autoclean = true);

def OpenRTM_aist.OutPortBase.OutPortBase.addConnectorListener (   self,
  callback_type,
  listener,
  autoclean = True 
)

Adding ConnectorListener type listener.

This operation adds certain listeners related to buffer writing and reading events. The following listener types are available.

  • ON_BUFFER_EMPTY: At the time of buffer empty
  • ON_BUFFER_READTIMEOUT: At the time of buffer read timeout

Listeners should have the following function operator().

ConnectorListener::operator()(const ConnectorProfile&)

The ownership of the given listener object is transferred to this OutPort object in default. The given listener object will be destroied automatically in the OutPort's dtor or if the listener is deleted by removeConnectorListener() function. If you want to keep ownership of the listener object, give "false" value to 3rd argument to inhibit automatic destruction.

Parameters
listener_typeA listener type
listenerA pointer to a listener object
autocleanA flag for automatic listener destruction

void addConnectorListener(ConnectorListenerType callback_type, ConnectorListener* listener, bool autoclean = true);

def OpenRTM_aist.OutPortBase.OutPortBase.connect (   self,
  connector_profile 
)

[CORBA interface] Connect the Port

This operation establishes connection according to the given ConnectionProfile inforamtion. This function is premised on calling from mainly application program or tools.

Parameters
connector_profileThe ConnectorProfile.
Returns
ReturnCode_t The return code of ReturnCode_t type.
def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorById (   self,
  id 
)

Getting ConnectorProfile by ID.

This operation returns Connector specified by ID.

Parameters
idConnector ID
Returns
A pointer to connector

OutPortConnector* getConnectorById(const char* id);

def OpenRTM_aist.OutPortBase.OutPortBase.getConnectorByName (   self,
  name 
)

Getting Connector by name.

This operation returns Connector specified by name.

Parameters
idConnector ID
Returns
A pointer to connector

OutPortConnector* getConnectorByName(const char* name);

def OpenRTM_aist.OutPortBase.OutPortBase.init (   self,
  prop 
)

Initializing properties.

This operation initializes outport's properties

void init(coil::Properties& prop);

def OpenRTM_aist.OutPortBase.OutPortBase.properties (   self)

Get properties.

Getting properties of this OutPort

Returns
OutPort's properties

coil::Properties& OutPortBase::properties()

def OpenRTM_aist.OutPortBase.OutPortBase.removeConnectorDataListener (   self,
  listener_type,
  listener 
)

Removing BufferDataListener type listener.

This operation removes a specified listener.

Parameters
listener_typeA listener type
listenerA pointer to a listener object

void removeConnectorDataListener(ConnectorDataListenerType listener_type, ConnectorDataListener* listener);

def OpenRTM_aist.OutPortBase.OutPortBase.removeConnectorListener (   self,
  callback_type,
  listener 
)

Removing BufferDataListener type listener.

This operation removes a specified listener.

Parameters
listener_typeA listener type
listenerA pointer to a listener object

void removeConnectorListener(ConnectorListenerType callback_type, ConnectorListener* listener);

def OpenRTM_aist.OutPortBase.OutPortBase.write (   self)

Write data.

Write data to the port. Write the value, which was set to the bound variable, to the port.

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

virtual bool write() = 0;


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