RTI Connext Traditional C++ API  Version 6.1.1
DDSReadCondition Class Referenceabstract

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

Inheritance diagram for DDSReadCondition:
DDSCondition DDSQueryCondition

Public Member Functions

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

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.

Examples:
HelloWorld_subscriber.cxx.

Member Function Documentation

◆ get_sample_state_mask()

virtual DDS_SampleStateMask DDSReadCondition::get_sample_state_mask ( )
pure virtual

Retrieves the set of sample_states for the condition.

◆ get_view_state_mask()

virtual DDS_ViewStateMask DDSReadCondition::get_view_state_mask ( )
pure virtual

Retrieves the set of view_states for the condition.

◆ get_instance_state_mask()

virtual DDS_InstanceStateMask DDSReadCondition::get_instance_state_mask ( )
pure virtual

Retrieves the set of instance_states for the condition.

◆ get_stream_kind_mask()

virtual DDS_StreamKindMask DDSReadCondition::get_stream_kind_mask ( )
pure virtual

Retrieves the set of instance_states for the condition.

◆ get_datareader()

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.