OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer Class Reference

More...

Inheritance diagram for OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer:

Public Member Functions
def	__init__ (self)
def	__del__ (self, CorbaConsumer=OpenRTM_aist.CorbaConsumer)
def	init (self, prop)
def	put (self, data)
def	publishInterfaceProfile (self, properties)
def	subscribeInterface (self, properties)
def	unsubscribeInterface (self, properties)
def	subscribeFromIor (self, properties)
def	subscribeFromRef (self, properties)
def	unsubscribeFromIor (self, properties)
def	unsubscribeFromRef (self, properties)
def	convertReturnCode (self, ret)
Public Member Functions inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
def	toString (status)
Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumer
def	__init__ (self, interfaceType=None, consumer=None)
def	equal (self, consumer)
def	setObject (self, obj)
def	releaseObject (self)
Public Member Functions inherited from OpenRTM_aist.CorbaConsumer.CorbaConsumerBase
def	__init__ (self, consumer=None)
def	equal (self, consumer)
def	setObject (self, obj)
def	getObject (self)
def	releaseObject (self)

Additional Inherited Members
Static Public Attributes inherited from OpenRTM_aist.DataPortStatus.DataPortStatus
int	PORT_OK = 0

Detailed Description

InPortCorbaCdrConsumer class

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

Parameters

DataType

Data type for this port

Since

0.4.0

Constructor & Destructor Documentation

__init__()

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.__init__

(

self

)

Constructor

Constructor

Parameters

buffer

The buffer object that is attached to this Consumer

Reimplemented from OpenRTM_aist.CorbaConsumer.CorbaConsumer.

Reimplemented in OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer, and OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer.

__del__()

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.__del__	(		self,
			CorbaConsumer = OpenRTM_aist.CorbaConsumer
	)

Destructor

Destructor

Reimplemented from OpenRTM_aist.CorbaConsumer.CorbaConsumer.

Reimplemented in OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer, and OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer.

Member Function Documentation

convertReturnCode()

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.convertReturnCode	(		self,
			ret
	)

Return codes conversion

ReturnCode convertReturnCode(OpenRTM::PortStatus ret)

init()

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);

Reimplemented in OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer, and OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer.

publishInterfaceProfile()

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

properties

Properties to get InterfaceProfile information

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

put()

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);

Reimplemented from OpenRTM_aist.InPortConsumer.InPortConsumer.

Reimplemented in OpenRTM_aist.InPortCSPConsumer.InPortCSPConsumer, and OpenRTM_aist.InPortSHMConsumer.InPortSHMConsumer.

subscribeFromIor()

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);

subscribeFromRef()

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);

subscribeInterface()

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

properties

Information for subscription

Returns

Subscription result (Successful:true, Failed:false)

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

unsubscribeFromIor()

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

ubsubscribing (IOR version)

Returns

true: succeeded, false: failed

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

unsubscribeFromRef()

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

ubsubscribing (Object reference version)

Returns

true: succeeded, false: failed

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

unsubscribeInterface()

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

Unsubscribe the data send notification

Unsubscribe the data send notification.

Parameters

properties

Information for unsubscription

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

---

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

• C:/docs/OpenRTM-aist-Python/OpenRTM_aist/InPortCorbaCdrConsumer.py