OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer Class Reference

InPortCorbaCdrConsumer class. More...

Inheritance diagram for OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer:

List of all members.

Public Member Functions
def	__del__
	Destructor.
def	__init__
	Constructor.
def	convertReturnCode
	Return codes conversionReturnCode convertReturnCode(OpenRTM::PortStatus ret)
def	init
	Initializing configuration.
def	publishInterfaceProfile
	Publish InterfaceProfile information.
def	put
	Send data to the destination port.
def	subscribeFromIor
	Getting object reference fromn IOR string.
def	subscribeFromRef
	Getting object reference fromn Any directry.
def	subscribeInterface
	Subscribe to the data sending notification.
def	unsubscribeFromIor
	ubsubscribing (IOR version)
def	unsubscribeFromRef
	ubsubscribing (Object reference version)
def	unsubscribeInterface
	Unsubscribe the data send notification.
Private Attributes
	_properties
	_rtcout

---

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

Definition at line 52 of file InPortCorbaCdrConsumer.py.

---

Constructor & Destructor Documentation

def OpenRTM_aist.InPortCorbaCdrConsumer.InPortCorbaCdrConsumer.__init__

(

self

)

Constructor.

Constructor

Parameters:

buffer

The buffer object that is attached to this Consumer

Reimplemented from OpenRTM_aist.DataPortStatus.DataPortStatus.

Reimplemented in test_PublisherNew.ConsumerMock, and test_PublisherPeriodic.ConsumerMock.

Definition at line 73 of file InPortCorbaCdrConsumer.py.

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

Destructor.

Destructor

Definition at line 92 of file InPortCorbaCdrConsumer.py.

---

Member Function Documentation

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

Return codes conversionReturnCode convertReturnCode(OpenRTM::PortStatus ret)

Reimplemented in test_PublisherNew.ConsumerMock, and test_PublisherPeriodic.ConsumerMock.

Definition at line 431 of file InPortCorbaCdrConsumer.py.

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

Definition at line 112 of file InPortCorbaCdrConsumer.py.

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

Definition at line 189 of file InPortCorbaCdrConsumer.py.

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 in test_PublisherNew.ConsumerMock, and test_PublisherPeriodic.ConsumerMock.

Definition at line 150 of file InPortCorbaCdrConsumer.py.

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

Definition at line 271 of file InPortCorbaCdrConsumer.py.

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

Definition at line 317 of file InPortCorbaCdrConsumer.py.

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

Definition at line 215 of file InPortCorbaCdrConsumer.py.

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

ubsubscribing (IOR version)

Returns:

true: succeeded, false: failed

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

Definition at line 359 of file InPortCorbaCdrConsumer.py.

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

ubsubscribing (Object reference version)

Returns:

true: succeeded, false: failed

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

Definition at line 400 of file InPortCorbaCdrConsumer.py.

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

Definition at line 247 of file InPortCorbaCdrConsumer.py.

---

Member Data Documentation

OpenRTM_aist::InPortCorbaCdrConsumer.InPortCorbaCdrConsumer::_properties [private]

Definition at line 73 of file InPortCorbaCdrConsumer.py.

OpenRTM_aist::InPortCorbaCdrConsumer.InPortCorbaCdrConsumer::_rtcout [private]

Definition at line 73 of file InPortCorbaCdrConsumer.py.

---

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

• InPortCorbaCdrConsumer.py