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

Public Member Functions

def __del__ (self)
 
def __init__ (self)
 Constructor. More...
 
def convertReturnCode (self, ret)
 Return codes conversionReturnCode convertReturnCode(OpenRTM::PortStatus ret) More...
 
def get_m_put_data (self)
 
def get_m_put_data_len (self)
 
def put (self, data)
 Send data to the destination port. More...
 
- Public Member Functions inherited from OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer
def __del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
 Destructor. More...
 
def init (self, prop)
 Initializing configuration. More...
 
def publishInterfaceProfile (self, properties)
 Publish InterfaceProfile information. More...
 
def subscribeFromIor (self, properties)
 Getting object reference fromn IOR string. More...
 
def subscribeFromRef (self, properties)
 Getting object reference fromn Any directry. More...
 
def subscribeInterface (self, properties)
 Subscribe to the data sending notification. More...
 
def unsubscribeFromIor (self, properties)
 ubsubscribing (IOR version) More...
 
def unsubscribeFromRef (self, properties)
 ubsubscribing (Object reference version) More...
 
def unsubscribeInterface (self, properties)
 Unsubscribe the data send notification. More...
 
- Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def toString (status)
 Convert DataPortStatus into the string. More...
 
- Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumer
def __init__ (self, interfaceType=None, consumer=None)
 Consructor. More...
 
def equal (self, consumer)
 Assignment operator. More...
 
def releaseObject (self)
 
def setObject (self, obj)
 Set Object. More...
 
- Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumerBase
def __init__ (self, consumer=None)
 Consructor. More...
 
def getObject (self)
 Get CORBA Object. More...
 

Private Attributes

 _buffer
 

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 26 of file test_PublisherPeriodic.py.

Constructor & Destructor Documentation

◆ __init__()

def test_PublisherPeriodic.ConsumerMock.__init__ (   self)

Constructor.

Constructor

Parameters
bufferThe buffer object that is attached to this Consumer

Reimplemented from OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.

Definition at line 27 of file test_PublisherPeriodic.py.

◆ __del__()

def test_PublisherPeriodic.ConsumerMock.__del__ (   self)

Reimplemented from OpenRTM_aist.CorbaConsumer.CorbaConsumer.

Definition at line 34 of file test_PublisherPeriodic.py.

Member Function Documentation

◆ convertReturnCode()

def test_PublisherPeriodic.ConsumerMock.convertReturnCode (   self,
  ret 
)

Return codes conversionReturnCode convertReturnCode(OpenRTM::PortStatus ret)

Reimplemented from OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.

Definition at line 37 of file test_PublisherPeriodic.py.

◆ get_m_put_data()

def test_PublisherPeriodic.ConsumerMock.get_m_put_data (   self)

Definition at line 78 of file test_PublisherPeriodic.py.

◆ get_m_put_data_len()

def test_PublisherPeriodic.ConsumerMock.get_m_put_data_len (   self)

Definition at line 83 of file test_PublisherPeriodic.py.

◆ put()

def test_PublisherPeriodic.ConsumerMock.put (   self,
  data 
)

Send data to the destination port.

Pure virtual function to send data to the destination port.

This function might the following return codes

  • PORT_OK: Normal return
  • PORT_ERROR: Error occurred in data transfer process
  • SEND_FULL: Buffer full although OutPort tried to send data
  • SEND_TIMEOUT: Timeout although OutPort tried to send data
  • UNKNOWN_ERROR: Unknown error

virtual ReturnCode put(const cdrMemoryStream& data);

Reimplemented from OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.

Definition at line 56 of file test_PublisherPeriodic.py.

Member Data Documentation

◆ _buffer

test_PublisherPeriodic.ConsumerMock._buffer
private

Definition at line 32 of file test_PublisherPeriodic.py.


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


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Mon Apr 21 2025 02:45:08