OpenRTM-aist-Python 1.2.1
Public Member Functions | List of all members
OpenRTM_aist.InPortDirectConsumer.InPortDirectConsumer Class Reference

InPortDirectConsumer class. More...

Inheritance diagram for OpenRTM_aist.InPortDirectConsumer.InPortDirectConsumer:
OpenRTM_aist.InPortConsumer.InPortConsumer OpenRTM_aist.DataPortStatus.DataPortStatus

Public Member Functions

def __init__ (self)
 Constructor. More...
 
def __del__ (self)
 Destructor. More...
 
def init (self, prop)
 Initializing configuration. More...
 
def put (self, data)
 
def publishInterfaceProfile (self, properties)
 Publish InterfaceProfile information. More...
 
def subscribeInterface (self, properties)
 Subscribe to the data sending notification. 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...
 

Additional Inherited Members

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

Detailed Description

InPortDirectConsumer class.

Constructor & Destructor Documentation

def OpenRTM_aist.InPortDirectConsumer.InPortDirectConsumer.__init__ (   self)

Constructor.

Constructor

Parameters
self
def OpenRTM_aist.InPortDirectConsumer.InPortDirectConsumer.__del__ (   self)

Destructor.

Destructor

Parameters
self

Member Function Documentation

def OpenRTM_aist.InPortDirectConsumer.InPortDirectConsumer.init (   self,
  prop 
)

Initializing configuration.

virtual void init(coil::Properties& prop);

def OpenRTM_aist.InPortDirectConsumer.InPortDirectConsumer.publishInterfaceProfile (   self,
  properties 
)

Publish InterfaceProfile information.

Parameters
self
propertiesProperties to get InterfaceProfile information

virtual void publishInterfaceProfile(SDOPackage::NVList& properties);

def OpenRTM_aist.InPortDirectConsumer.InPortDirectConsumer.put (   self,
  data 
)
Parameters
self
data
Returns

virtual ReturnCode put(const cdrMemoryStream& data);

def OpenRTM_aist.InPortDirectConsumer.InPortDirectConsumer.subscribeInterface (   self,
  properties 
)

Subscribe to the data sending notification.

Parameters
self
propertiesInformation for subscription
Returns
Subscription result (Successful:true, Failed:false)

virtual bool subscribeInterface(const SDOPackage::NVList& properties);

def OpenRTM_aist.InPortDirectConsumer.InPortDirectConsumer.unsubscribeInterface (   self,
  properties 
)

Unsubscribe the data send notification.

Parameters
self
propertiesInformation for unsubscription

virtual void unsubscribeInterface(const SDOPackage::NVList& properties);


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