RTI Connext .Net APIs  Version 5.1.0
DDS::ReadCondition Class Reference

<<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.
 
System::UInt32 get_view_state_mask ()
 Retrieves the set of view_states for the condition.
 
System::UInt32 get_instance_state_mask ()
 Retrieves the set of instance_states for the condition.
 
DataReaderget_datareader ()
 Returns the DDS::DataReader associated with the DDS::ReadCondition.
 
virtual System::Boolean get_trigger_value () override
 Retrieve the trigger_value.
 

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.

Note: If you are using a ReadCondition simply to detect the presence of new data, consider using a DDS::StatusCondition with the DATA_AVAILABLE_STATUS instead, which will perform better in this situation.

Member Function Documentation

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

Retrieves the set of sample_states for the condition.

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

Retrieves the set of view_states for the condition.

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

Retrieves the set of instance_states for the condition.

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.
virtual System::Boolean DDS::ReadCondition::get_trigger_value ( )
overridevirtual

Retrieve the trigger_value.

Returns
the trigger value.

Implements DDS::Condition.

Reimplemented in DDS::QueryCondition.


RTI Connext .Net APIs Version 5.1.0 Copyright © Mon Feb 3 2014 Real-Time Innovations, Inc