Inheritance diagram for OutPort::PublisherFlushMock:

Public Member Functions
RTC::PublisherBase::ReturnCode	activate ()
	activation
RTC::PublisherBase::ReturnCode	deactivate ()
	deactivation
RTC::PublisherBase::ReturnCode	init (coil::Properties &prop)
	Initializing configuration.
bool	isActive ()
	If publisher is active state.
	PublisherFlushMock ()
RTC::PublisherBase::ReturnCode	setBuffer (RTC::CdrBufferBase *buffer)
RTC::PublisherBase::ReturnCode	setConsumer (RTC::InPortConsumer *consumer)
	Store InPort consumer.
::RTC::DataPortStatus::Enum	setListener (RTC::ConnectorInfo &info, RTC::ConnectorListeners *listeners)
	Set the listener.
void	setLogger (Logger *logger)
RTC::PublisherBase::ReturnCode	write (const cdrMemoryStream &data, unsigned long sec, unsigned long usec)
	Write data.
	~PublisherFlushMock ()
Static Public Attributes
static Logger	logger
Private Attributes
Logger *	m_logger

Detailed Description

Definition at line 530 of file OutPortTests.cpp.

Constructor & Destructor Documentation

OutPort::PublisherFlushMock::PublisherFlushMock ( ) [inline]

Definition at line 534 of file OutPortTests.cpp.

OutPort::PublisherFlushMock::~PublisherFlushMock ( ) [inline]

Definition at line 538 of file OutPortTests.cpp.

Member Function Documentation

RTC::PublisherBase::ReturnCode OutPort::PublisherFlushMock::activate ( ) [inline, virtual]

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

Implements RTC::PublisherBase.

Definition at line 583 of file OutPortTests.cpp.

RTC::PublisherBase::ReturnCode OutPort::PublisherFlushMock::deactivate ( ) [inline, virtual]

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

Implements RTC::PublisherBase.

Definition at line 597 of file OutPortTests.cpp.

RTC::PublisherBase::ReturnCode OutPort::PublisherFlushMock::init ( coil::Properties & prop ) [inline, virtual]

Initializing configuration.

This operation would be called to configure in initialization. In the concrete class, configuration should be performed getting appropriate information from the given Properties data. This function might be called right after instantiation and connection sequence respectivly. Therefore, this function should be implemented assuming multiple call.

Parameters:

prop	Configuration information

Implements RTC::PublisherBase.

Definition at line 610 of file OutPortTests.cpp.

bool OutPort::PublisherFlushMock::isActive ( ) [inline, virtual]

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)

Implements RTC::PublisherBase.

Definition at line 574 of file OutPortTests.cpp.

RTC::PublisherBase::ReturnCode OutPort::PublisherFlushMock::setBuffer ( RTC::CdrBufferBase * buffer ) [inline]

Definition at line 632 of file OutPortTests.cpp.

RTC::PublisherBase::ReturnCode OutPort::PublisherFlushMock::setConsumer ( RTC::InPortConsumer * consumer ) [inline, virtual]

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

Implements RTC::PublisherBase.

Definition at line 618 of file OutPortTests.cpp.

::RTC::DataPortStatus::Enum OutPort::PublisherFlushMock::setListener	(	RTC::ConnectorInfo &	info,
		RTC::ConnectorListeners *	listeners
	)		`[inline, virtual]`

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

Implements RTC::PublisherBase.

Definition at line 662 of file OutPortTests.cpp.

void OutPort::PublisherFlushMock::setLogger ( Logger * logger ) [inline]

Definition at line 693 of file OutPortTests.cpp.

RTC::PublisherBase::ReturnCode OutPort::PublisherFlushMock::write	(	const cdrMemoryStream &	data,
		unsigned long	sec,
		unsigned long	usec
	)		`[inline, virtual]`

Write data.

This function writes data into the 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 etc. will be performed.

When publisher writes data, 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

Implements RTC::PublisherBase.

Definition at line 545 of file OutPortTests.cpp.

Member Data Documentation

Logger OutPort::PublisherFlushMock::logger [static]

Definition at line 697 of file OutPortTests.cpp.

Logger* OutPort::PublisherFlushMock::m_logger [private]

Definition at line 699 of file OutPortTests.cpp.

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

OutPortTests.cpp

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation