OpenRTM_aist.InPortConnector.InPortConnector Class Reference

I£îPortConnector base class. More...

Inheritance diagram for OpenRTM_aist.InPortConnector.InPortConnector:
OpenRTM_aist.ConnectorBase.ConnectorBase OpenRTM_aist.DataPortStatus.DataPortStatus OpenRTM_aist.InPortPullConnector.InPortPullConnector OpenRTM_aist.InPortPushConnector.InPortPushConnector

List of all members.

Public Member Functions

def __init__
 Constructor.
def __del__
 Destructor.
def profile
 Getting ConnectorInfo.
def id
 Getting Connector ID.
def name
 Getting Connector name.
def disconnect
 Disconnect connection.
def getBuffer
 Getting Buffer.
def read
 Destructor.

Detailed Description

I£îPortConnector base class.

The base class to derive subclasses for InPort's Push/Pull Connectors

Since:
1.0.0

Member Function Documentation

def OpenRTM_aist.InPortConnector.InPortConnector.__init__ (   self,
  info,
  buffer 
)

Constructor.

InPortConnector(ConnectorInfo& info, CdrBufferBase* buffer);

def OpenRTM_aist.InPortConnector.InPortConnector.disconnect (   self  ) 

Disconnect connection.

This operation disconnect this connection

virtual ReturnCode disconnect() = 0;

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Reimplemented in OpenRTM_aist.InPortPullConnector.InPortPullConnector, and OpenRTM_aist.InPortPushConnector.InPortPushConnector.

def OpenRTM_aist.InPortConnector.InPortConnector.getBuffer (   self  ) 

Getting Buffer.

This operation returns this connector's buffer

virtual CdrBufferBase* getBuffer();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

def OpenRTM_aist.InPortConnector.InPortConnector.id (   self  ) 

Getting Connector ID.

This operation returns Connector ID

const char* id();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

def OpenRTM_aist.InPortConnector.InPortConnector.name (   self  ) 

Getting Connector name.

This operation returns Connector name

const char* name();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

def OpenRTM_aist.InPortConnector.InPortConnector.profile (   self  ) 

Getting ConnectorInfo.

This operation returns ConnectorInfo

const ConnectorInfo& profile();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

def OpenRTM_aist.InPortConnector.InPortConnector.read (   self,
  data 
)

Destructor.

The read function to read data from buffer to InPort

virtual ReturnCode read(cdrMemoryStream& data) = 0;

Reimplemented in OpenRTM_aist.InPortPullConnector.InPortPullConnector, and OpenRTM_aist.InPortPushConnector.InPortPushConnector.


The documentation for this class was generated from the following file:
Generated on Mon Mar 2 14:14:04 2015 for OpenRTM-aist-1.1.0-Python by  doxygen 1.6.3