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

InPortCorbaCdrConsumer class. More...

Inheritance diagram for OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer:
OpenRTM_aist.InPortConsumer.InPortConsumer OpenRTM_aist.CorbaConsumer.CorbaConsumer OpenRTM_aist.DataPortStatus.DataPortStatus OpenRTM_aist.CorbaConsumer.CorbaConsumerBase

Public Member Functions

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

Additional Inherited Members

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

Detailed Description

InPortCorbaCdrConsumer class.

This is an implementation class of the input port Consumer that uses CORBA for means of communication.

Parameters
DataTypeData type for this port
Since
0.4.0

Constructor & Destructor Documentation

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.__init__ (   self)

Constructor.

Constructor

Parameters
bufferThe buffer object that is attached to this Consumer
def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.__del__ (   self,
  CorbaConsumer = OpenRTM_aist.CorbaConsumer 
)

Destructor.

Destructor

Member Function Documentation

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

Initializing configuration.

This operation would be called to configure this consumer in initialization.

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

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

Publish InterfaceProfile information.

Publish interfaceProfile information. Check the dataport.interface_type value of the NameValue object specified by an argument in property information and get information only when the interface type of the specified port is matched.

Parameters
propertiesProperties to get InterfaceProfile information

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

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.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);

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.subscribeFromIor (   self,
  properties 
)

Getting object reference fromn IOR string.

Returns
true: succeeded, false: failed

bool subscribeFromIor(const SDOPackage::NVList& properties);

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.subscribeFromRef (   self,
  properties 
)

Getting object reference fromn Any directry.

Returns
true: succeeded, false: failed

bool subscribeFromRef(const SDOPackage::NVList& properties);

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

Subscribe to the data sending notification.

Subscribe to the data sending notification based on specified property information.

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

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

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.unsubscribeFromIor (   self,
  properties 
)

ubsubscribing (IOR version)

Returns
true: succeeded, false: failed

bool unsubscribeFromIor(const SDOPackage::NVList& properties);

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.unsubscribeFromRef (   self,
  properties 
)

ubsubscribing (Object reference version)

Returns
true: succeeded, false: failed

bool unsubscribeFromRef(const SDOPackage::NVList& properties);

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

Unsubscribe the data send notification.

Unsubscribe the data send notification.

Parameters
propertiesInformation for unsubscription

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


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