Public Member Functions | Private Attributes
OpenRTM_aist.InPortConnector.InPortConnector Class Reference

I£îPortConnector base class. More...

Inheritance diagram for OpenRTM_aist.InPortConnector.InPortConnector:
Inheritance graph
[legend]

List of all members.

Public Member Functions

def __del__
 Destructor.
def __init__
 ConstructorInPortConnector(ConnectorInfo& info, CdrBufferBase* buffer);.
def disconnect
 Disconnect connection.
def getBuffer
 Getting Buffer.
def id
 Getting Connector ID.
def name
 Getting Connector name.
def profile
 Getting ConnectorInfo.
def read
 Destructor.
def setConnectorInfo
def setDataType

Private Attributes

 _buffer
 _dataType
 _endian
 _profile
 _rtcout

Detailed Description

I£îPortConnector base class.

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

Since:
1.0.0

Definition at line 43 of file InPortConnector.py.


Constructor & Destructor Documentation

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

ConstructorInPortConnector(ConnectorInfo& info, CdrBufferBase* buffer);.

Definition at line 56 of file InPortConnector.py.


Member Function Documentation

Disconnect connection.

This operation disconnect this connection

virtual ReturnCode disconnect() = 0;

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

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

Definition at line 146 of file InPortConnector.py.

Getting Buffer.

This operation returns this connector's buffer

virtual CdrBufferBase* getBuffer();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 163 of file InPortConnector.py.

Getting Connector ID.

This operation returns Connector ID

const char* id();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 108 of file InPortConnector.py.

Getting Connector name.

This operation returns Connector name

const char* name();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 127 of file InPortConnector.py.

Getting ConnectorInfo.

This operation returns ConnectorInfo

const ConnectorInfo& profile();

Reimplemented from OpenRTM_aist.ConnectorBase.ConnectorBase.

Definition at line 89 of file InPortConnector.py.

Destructor.

The read function to read data from buffer to InPort

virtual ReturnCode read(cdrMemoryStream& data) = 0;

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

Definition at line 180 of file InPortConnector.py.

Definition at line 184 of file InPortConnector.py.

Definition at line 212 of file InPortConnector.py.


Member Data Documentation

Definition at line 56 of file InPortConnector.py.

Definition at line 56 of file InPortConnector.py.

Definition at line 56 of file InPortConnector.py.

Definition at line 56 of file InPortConnector.py.


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


openrtm_aist_python
Author(s): Shinji Kurihara
autogenerated on Thu Aug 27 2015 14:17:29