OpenRTM-aist-Python 2.0.0
Public Member Functions | List of all members
OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector Class Reference
Inheritance diagram for OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector:
OpenRTM_aist.OutPortConnector.OutPortConnector OpenRTM_aist.ConnectorBase.ConnectorBase OpenRTM_aist.DataPortStatus.DataPortStatus

Public Member Functions

def __init__ (self, info, provider, listeners, buffer=None)
 
def __del__ (self)
 
def write (self, data)
 
def isWritable (self, retry=False)
 
def read (self, data=None)
 
def isReadable (self, retry=False)
 
def setReadListener (self, listener)
 
def setIsReadableListener (self, listener)
 
def disconnect (self)
 
def getBuffer (self)
 
def activate (self)
 
def deactivate (self)
 
def createBuffer (self, info)
 
def onConnect (self)
 
def onDisconnect (self)
 
def setConsumer (self, consumer)
 
def serializeData (self, data)
 
def unsubscribeInterface (self, prop)
 
- Public Member Functions inherited from OpenRTM_aist.OutPortConnector.OutPortConnector
def __init__ (self, info)
 
def __del__ (self)
 
def profile (self)
 
def id (self)
 
def name (self)
 
def setDirectMode (self)
 
def directMode (self)
 
def setConsumer (self, consumer)
 
def unsubscribeInterface (self, prop)
 
def __del__ (self)
 
def profile (self)
 
def id (self)
 
def name (self)
 
def disconnect (self)
 
def getBuffer (self)
 
def activate (self)
 
def deactivate (self)
 
- Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def toString (status)
 

Additional Inherited Members

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

Detailed Description

 

Constructor & Destructor Documentation

◆ __init__()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.__init__ (   self,
  info,
  provider,
  listeners,
  buffer = None 
)

Constructor

Parameters
infoConnectorInfo
providerOutPortProvider
listenersConnectorListeners type lsitener object list
bufferCdrBufferBase type buffer

OutPortPullConnector(ConnectorInfo info, OutPortProvider* provider, ConnectorListeners& listeners, CdrBufferBase* buffer = 0);

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ __del__()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.__del__ (   self)

Destructor

This operation calls disconnect(), which destructs and deletes the consumer, the publisher and the buffer.

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

Member Function Documentation

◆ activate()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.activate (   self)

Connector activation

This operation activates this connector

virtual void activate(){}; // do nothing

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

◆ createBuffer()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.createBuffer (   self,
  info 
)

create buffer

CdrBufferBase* createBuffer(ConnectorInfo& info);

◆ deactivate()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.deactivate (   self)

Connector deactivation

This operation deactivates this connector

virtual void deactivate(){}; // do nothing

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

◆ disconnect()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.disconnect (   self)

disconnect

This operation destruct and delete the consumer, the publisher and the buffer.

virtual ReturnCode disconnect();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

◆ getBuffer()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.getBuffer (   self)

Getting Buffer

This operation returns this connector's buffer

virtual CdrBufferBase* getBuffer();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

◆ isReadable()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.isReadable (   self,
  retry = False 
)

Parameters
self
retry
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ isWritable()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.isWritable (   self,
  retry = False 
)

Parameters
self
retry
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ onConnect()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.onConnect (   self)

Invoke callback when connection is established void onConnect()

◆ onDisconnect()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.onDisconnect (   self)

Invoke callback when connection is destroied void onDisconnect()

◆ read()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.read (   self,
  data = None 
)

Parameters
self
data
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ serializeData()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.serializeData (   self,
  data 
)

Parameters
self
cdr
Returns

◆ setConsumer()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.setConsumer (   self,
  consumer 
)

set Consumer

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ setIsReadableListener()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.setIsReadableListener (   self,
  listener 
)

Parameters
self
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ setReadListener()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.setReadListener (   self,
  listener 
)

Parameters
self
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ unsubscribeInterface()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.unsubscribeInterface (   self,
  prop 
)

Parameters
prop

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ write()

def OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.write (   self,
  data 
)

Parameters
self
data
Returns

virtual ReturnCode write(const cdrMemoryStream& data);

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.


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