RTI Connext .NET API (legacy)  Version 6.1.2

<<interface>> Conditions specifically dedicated to read operations and attached to one DDS::DataReader. More...

#include <managed_subscription.h>

Inheritance diagram for DDS::ReadCondition:
DDS::Condition DDS::QueryCondition

Public Member Functions

System::UInt32 get_sample_state_mask ()
 Retrieves the set of sample_states for the condition. More...
 
System::UInt32 get_view_state_mask ()
 Retrieves the set of view_states for the condition. More...
 
System::UInt32 get_instance_state_mask ()
 Retrieves the set of instance_states for the condition. More...
 
System::UInt32 get_stream_kind_mask ()
 Retrieves the set of stream kind mask for the condition. More...
 
DataReaderget_datareader ()
 Returns the DDS::DataReader associated with the DDS::ReadCondition. More...
 
virtual System::Boolean get_trigger_value () override
 Retrieve the trigger_value. More...
 

Detailed Description

<<interface>> Conditions specifically dedicated to read operations and attached to one DDS::DataReader.

DDS::ReadCondition 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 DDS::TypedDataReader::read and DDS::TypedDataReader::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 DDS::ReadCondition may be attached to the same DDS::DataReader.

Member Function Documentation

◆ get_sample_state_mask()

System::UInt32 DDS::ReadCondition::get_sample_state_mask ( )

Retrieves the set of sample_states for the condition.

◆ get_view_state_mask()

System::UInt32 DDS::ReadCondition::get_view_state_mask ( )

Retrieves the set of view_states for the condition.

◆ get_instance_state_mask()

System::UInt32 DDS::ReadCondition::get_instance_state_mask ( )

Retrieves the set of instance_states for the condition.

◆ get_stream_kind_mask()

System::UInt32 DDS::ReadCondition::get_stream_kind_mask ( )

Retrieves the set of stream kind mask for the condition.

◆ get_datareader()

DataReader ^ DDS::ReadCondition::get_datareader ( )

Returns the DDS::DataReader associated with the DDS::ReadCondition.

There is exactly one DDS::DataReader assicated with each DDS::ReadCondition.

Returns
DDS::DataReader associated with the DDS::ReadCondition.

◆ get_trigger_value()

virtual System::Boolean DDS::ReadCondition::get_trigger_value ( )
overridevirtual

Retrieve the trigger_value.

Returns
the trigger value.

Implements DDS::Condition.

Reimplemented in DDS::QueryCondition.