OpenRTM-aist-Python 1.1.2
Classes | Public Member Functions | List of all members
OpenRTM_aist.OutPort.OutPort Class Reference
Inheritance diagram for OpenRTM_aist.OutPort.OutPort:
OpenRTM_aist.OutPortBase.OutPortBase OpenRTM_aist.PortBase.PortBase OpenRTM_aist.DataPortStatus.DataPortStatus

Classes

class  subscribe
 

Public Member Functions

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

 

Constructor & Destructor Documentation

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

Constructor.

Member Function Documentation

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

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

Set OnWriteConvert callback.

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

Write data.

virtual bool write(const DataType& value)

bool operator<<(DataType& value)


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