OpenRTM-aist-Python 1.1.2
Public Member Functions | List of all members
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

Public Member Functions

def __init__
 ConstructorInPortConnector(ConnectorInfo& info, CdrBufferBase* buffer);.
 
def __del__
 Destructor.
 
def profile
 Getting ConnectorInfo. More...
 
def id
 Getting Connector ID. More...
 
def name
 Getting Connector name. More...
 
def disconnect
 Disconnect connection. More...
 
def getBuffer
 Getting Buffer. More...
 
def read
 Destructor. More...
 
- Public Member Functions inherited from OpenRTM_aist.ConnectorBase.ConnectorBase
def __del__
 Destructor.
 
def profile
 Getting Profile. More...
 
def id
 Getting Connector ID. More...
 
def name
 Getting Connector name. More...
 
def disconnect
 Disconnect connection. More...
 
def getBuffer
 Getting Buffer. More...
 
def activate
 Connector activation. More...
 
def deactivate
 Connector deactivation. More...
 
- Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def toString
 Convert DataPortStatus into the string. More...
 

Additional Inherited Members

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

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.disconnect (   self)

Disconnect connection.

This operation disconnect this connection

virtual ReturnCode disconnect() = 0;

def OpenRTM_aist.InPortConnector.InPortConnector.getBuffer (   self)

Getting Buffer.

This operation returns this connector's buffer

virtual CdrBufferBase* getBuffer();

def OpenRTM_aist.InPortConnector.InPortConnector.id (   self)

Getting Connector ID.

This operation returns Connector ID

const char* id();

def OpenRTM_aist.InPortConnector.InPortConnector.name (   self)

Getting Connector name.

This operation returns Connector name

const char* name();

def OpenRTM_aist.InPortConnector.InPortConnector.profile (   self)

Getting ConnectorInfo.

This operation returns ConnectorInfo

const ConnectorInfo& profile();

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;


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