DDSReadCondition Class Reference

<<interface>> Conditions specifically dedicated to read operations and attached to one DDSDataReader. More...

Inheritance diagram for DDSReadCondition:

Public Member Functions
virtual DDS_SampleStateMask	get_sample_state_mask ()=0
	Retrieves the set of sample_states for the condition.
virtual DDS_ViewStateMask	get_view_state_mask ()=0
	Retrieves the set of view_states for the condition.
virtual DDS_InstanceStateMask	get_instance_state_mask ()=0
	Retrieves the set of instance_states for the condition.
virtual DDS_StreamKindMask	get_stream_kind_mask ()=0
	Retrieves the set of instance_states for the condition.
virtual DDSDataReader *	get_datareader ()=0
	Returns the DDSDataReader associated with the DDSReadCondition.
Public Member Functions inherited from DDSCondition
virtual DDS_Boolean	get_trigger_value ()=0
	Retrieve the trigger_value.
virtual DDS_ReturnCode_t	set_handler (DDSConditionHandler *handler)
	Registers a DDSConditionHandler in this DDSCondition.
virtual DDSConditionHandler *	get_handler ()
	Returns the registered DDSConditionHandler.
virtual void	dispatch ()
	Calls DDSConditionHandler::on_condition_triggered of the registered DDSConditionHandler.

Detailed Description

<<interface>> Conditions specifically dedicated to read operations and attached to one DDSDataReader.

DDSReadCondition objects allow an application to specify the data samples it is interested in (by specifying the desired sample_states, view_states as well as instance_states in FooDataReader::read and FooDataReader::take variants.

This allows RTI Connext to enable the condition only when suitable information is available. They are to be used in conjunction with a WaitSet as normal conditions.

More than one DDSReadCondition may be attached to the same DDSDataReader.

Member Function Documentation

virtual DDS_SampleStateMask DDSReadCondition::get_sample_state_mask ( )

pure virtual

Retrieves the set of sample_states for the condition.

virtual DDS_ViewStateMask DDSReadCondition::get_view_state_mask ( )

pure virtual

Retrieves the set of view_states for the condition.

virtual DDS_InstanceStateMask DDSReadCondition::get_instance_state_mask ( )

pure virtual

Retrieves the set of instance_states for the condition.

virtual DDS_StreamKindMask DDSReadCondition::get_stream_kind_mask ( )

pure virtual

Retrieves the set of instance_states for the condition.

virtual DDSDataReader* DDSReadCondition::get_datareader ( )

pure virtual

Returns the DDSDataReader associated with the DDSReadCondition.

There is exactly one DDSDataReader assicated with each DDSReadCondition.

Returns

DDSDataReader associated with the DDSReadCondition.