OpenRTM_aist.PublisherFlush.PublisherFlush Class Reference

Inheritance diagram for OpenRTM_aist.PublisherFlush.PublisherFlush:

Public Member Functions
def	__init__
	Constructor.
def	__del__
	Destructor.
def	init
	initialization
def	setConsumer
	Store InPort consumer.
def	setBuffer
	Setting buffer pointer.
def	setListener
	Set the listener.
def	write
	Write data.
def	isActive
	If publisher is active state.
def	activate
	activation
def	deactivate
	deactivation
def	onSend
	Notify an ON_SEND event to listners.
def	onReceived
	Notify an ON_RECEIVED event to listeners.
def	onReceiverFull
	Notify an ON_RECEIVER_FULL event to listeners.
def	onReceiverTimeout
	Notify an ON_RECEIVER_TIMEOUT event to listeners.
def	onReceiverError
	Notify an ON_RECEIVER_ERROR event to listeners.

Detailed Description

PublisherFlush class.

Member Function Documentation

def OpenRTM_aist.PublisherFlush.PublisherFlush.activate ( self )

activation

This function activates the publisher. By calling this function, this publisher starts the thread that pushes data to InPort. If precondition such as initialization process and so on is not met, the error code PRECONDITION_NOT_MET is returned.

Returns:: PORT_OK normal return PRECONDITION_NOT_MET precondition is not met

PublisherBase.ReturnCode PublisherFlush.activate()

Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.

def OpenRTM_aist.PublisherFlush.PublisherFlush.deactivate ( self )

deactivation

This function deactivates the publisher. By calling this function, this publisher stops the thread that pushes data to InPort. If precondition such as initialization process and so on is not met, the error code PRECONDITION_NOT_MET is returned.

Returns:: PORT_OK normal return PRECONDITION_NOT_MET precondition is not met

PublisherBase.ReturnCode PublisherFlush.deactivate()

Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.

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

initialization

This function have to be called before using this class object. However, this PublisherFlush class has no parameters to be initialized.

Parameters:

property

Property objects that includes the control information of this Publisher

Returns:: ReturnCode PORT_OK normal return INVALID_ARGS Properties with invalid values.

virtual ReturnCode init(coil.Properties& prop);

Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.

def OpenRTM_aist.PublisherFlush.PublisherFlush.isActive ( self )

If publisher is active state.

A Publisher can be activated/deactivated synchronized with the data port. The active state and the non-active state are made transition by the "activate()" and the "deactivate()" functions respectively. This function confirms if the publisher is in active state.

Returns:: Result of state confirmation (Active state:true, Inactive state:false)

bool PublisherFlush.isActive()

Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.

def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceived	(	self,
		data
	)

Notify an ON_RECEIVED event to listeners.

Parameters:

data

cdrMemoryStream

inline void onReceived(const cdrMemoryStream& data)

def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceiverError	(	self,
		data
	)

Notify an ON_RECEIVER_ERROR event to listeners.

Parameters:

data

cdrMemoryStream

inline void onReceiverError(const cdrMemoryStream& data)

def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceiverFull	(	self,
		data
	)

Notify an ON_RECEIVER_FULL event to listeners.

Parameters:

data

cdrMemoryStream

inline void onReceiverFull(const cdrMemoryStream& data)

def OpenRTM_aist.PublisherFlush.PublisherFlush.onReceiverTimeout	(	self,
		data
	)

Notify an ON_RECEIVER_TIMEOUT event to listeners.

Parameters:

data

cdrMemoryStream

inline void onReceiverTimeout(const cdrMemoryStream& data)

def OpenRTM_aist.PublisherFlush.PublisherFlush.onSend	(	self,
		data
	)

Notify an ON_SEND event to listners.

Parameters:

data

cdrMemoryStream

inline void onSend(const cdrMemoryStream& data)

def OpenRTM_aist.PublisherFlush.PublisherFlush.setBuffer	(	self,
		buffer
	)

Setting buffer pointer.

Since PublisherFlush does not use any buffers, This function always returns PORT_OK.

Parameters:

buffer

CDR buffer

Returns:: PORT_OK

PublisherBase.ReturnCode PublisherFlush.setBuffer(CdrBufferBase* buffer)

Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.

def OpenRTM_aist.PublisherFlush.PublisherFlush.setConsumer	(	self,
		consumer
	)

Store InPort consumer.

This operation sets a consumer that is associated with this object. If the consumer object is NULL, INVALID_ARGS will be returned.

Parameters:

consumer

A pointer to a consumer object.

Returns:: ReturnCode PORT_OK normal return INVALID_ARGS given argument has invalid value

PublisherFlush.setConsumer(InPortConsumer* consumer)

Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.

def OpenRTM_aist.PublisherFlush.PublisherFlush.setListener	(	self,
		info,
		listeners
	)

Set the listener.

This function sets ConnectorListeners listener object to the Publisher. By setting ConnectorListeners containing various listeners objects, these listeners are called at the time of reading and writing of a buffer, and transmission of data etc. Since the ownership of the ConnectorListeners object is owned by Port or RTObject, the Publisher never deletes the ConnectorListeners object. If the given ConnectorListeners' pointer is NULL, this function returns INVALID_ARGS.

Parameters:

	info	ConnectorInfo that is localized object of ConnectorProfile
	listeners	ConnectorListeners that holds various listeners

Returns:: PORT_OK Normal return INVALID_ARGS Invalid arguments

virtual RTC.DataPortStatus.Enum setListener(ConnectorInfo& info, RTC.ConnectorListeners* listeners);

Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.

def OpenRTM_aist.PublisherFlush.PublisherFlush.write	(	self,
		data,
		sec,
		usec
	)

Write data.

This function writes data into the consumer associated with this Publisher. If this function is called without initializing correctly such as a consumer, listeners, etc., error code PRECONDITION_NOT_MET will be returned and no operation of the writing to the consumer etc. will be performed.

When publisher writes data to the buffer, if the consumer returns full-status, returns error, is returned with timeout, error codes BUFFER_FULL, BUFFER_ERROR and BUFFER_TIMEOUT will be returned respectively.

In other cases, PROT_ERROR will be returned.

Parameters:

	data	Data to be wrote to the buffer
	sec	Timeout time in unit seconds
	nsec	Timeout time in unit nano-seconds

Returns:: PORT_OK Normal return PRECONDITION_NO_MET Precondition does not met. A consumer, a buffer, listenes are not set properly. SEND_FULL Data was sent but full-status returned SEND_TIMEOUT Data was sent but timeout occurred CONNECTION_LOST detected that the connection has been lost

PublisherBase.ReturnCode PublisherFlush.write(const cdrMemoryStream& data, unsigned long sec, unsigned long usec)

Reimplemented from OpenRTM_aist.PublisherBase.PublisherBase.

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

/var/lib/jenkins/jobs/01_openrtm-python-build-tags/workspace/OpenRTM_aist/PublisherFlush.py

OpenRTM_aist.PublisherFlush.PublisherFlush Class Reference

Public Member Functions

Detailed Description

Member Function Documentation