Classes | Public Member Functions | Private Attributes | List of all members
OpenRTM_aist.OutPort.OutPort Class Reference
Inheritance diagram for OpenRTM_aist.OutPort.OutPort:
Inheritance graph
[legend]

Classes

class  subscribe
 

Public Member Functions

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

Private Attributes

 _OnWrite
 
 _OnWriteConvert
 
 _value
 

Additional Inherited Members

- Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int BUFFER_EMPTY = 4
 
int BUFFER_ERROR = 2
 
int BUFFER_FULL = 3
 
int BUFFER_TIMEOUT = 5
 
int CONNECTION_LOST = 12
 
int INVALID_ARGS = 10
 
int PORT_ERROR = 1
 
int PORT_OK = 0
 DataPortStatus return codes. More...
 
int PRECONDITION_NOT_MET = 11
 
int RECV_EMPTY = 8
 
int RECV_TIMEOUT = 9
 
int SEND_FULL = 6
 
int SEND_TIMEOUT = 7
 
 toString = staticmethod(toString)
 
int UNKNOWN_ERROR = 13
 

Detailed Description

 

Definition at line 69 of file OutPort.py.

Constructor & Destructor Documentation

def OpenRTM_aist.OutPort.OutPort.__init__ (   self,
  name,
  value,
  buffer = None 
)

Constructor.

Definition at line 92 of file OutPort.py.

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

Definition at line 106 of file OutPort.py.

Member Function Documentation

def OpenRTM_aist.OutPort.OutPort.getPortDataType (   self)

Definition at line 286 of file OutPort.py.

def OpenRTM_aist.OutPort.OutPort.setOnWrite (   self,
  on_write 
)

Set read() block mode.

def setWriteBlock(self, block): self._writeBlock = block

Set write() timeout

def setWriteTimeout(self, timeout): self._writeTimeout = timeout

Set OnWrite callback

Definition at line 246 of file OutPort.py.

def OpenRTM_aist.OutPort.OutPort.setOnWriteConvert (   self,
  on_wconvert 
)

Set OnWriteConvert callback.

Definition at line 268 of file OutPort.py.

def OpenRTM_aist.OutPort.OutPort.write (   self,
  value = None 
)

Write data.

virtual bool write(const DataType& value)

bool operator<<(DataType& value)

Definition at line 154 of file OutPort.py.

Member Data Documentation

OpenRTM_aist.OutPort.OutPort._OnWrite
private

Definition at line 98 of file OutPort.py.

OpenRTM_aist.OutPort.OutPort._OnWriteConvert
private

Definition at line 99 of file OutPort.py.

OpenRTM_aist.OutPort.OutPort._value
private

Definition at line 94 of file OutPort.py.


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


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Thu Jun 6 2019 19:11:37