OpenRTM-aist-Python 2.0.2
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

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

Additional Inherited Members

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

Detailed Description

 

Constructor & Destructor Documentation

◆ __init__()

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__()

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()

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()

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

create buffer

CdrBufferBase* createBuffer(ConnectorInfo& info);

◆ deactivate()

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()

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()

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()

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

Parameters
self
retry
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ isWritable()

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

Parameters
self
retry
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ onConnect()

OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.onConnect ( self)

Invoke callback when connection is established void onConnect()

◆ onDisconnect()

OpenRTM_aist.OutPortDuplexConnector.OutPortDuplexConnector.onDisconnect ( self)

Invoke callback when connection is destroied void onDisconnect()

◆ read()

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

Parameters
self
data
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ serializeData()

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

Parameters
self
cdr
Returns

◆ setConsumer()

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

set Consumer

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ setIsReadableListener()

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

Parameters
self
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ setReadListener()

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

Parameters
self
Returns

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ unsubscribeInterface()

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

Parameters
prop

Reimplemented from OpenRTM_aist.OutPortConnector.OutPortConnector.

◆ write()

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: