RTI Connext Modern C++ API  Version 6.1.0
rti::sub::status::DataStateEx Class Reference

<<extension>> <<value-type>> An extended version of dds::sub::status::DataState that also contains StreamKind More...

#include <DataStateEx.hpp>

Inheritance diagram for rti::sub::status::DataStateEx:
dds::sub::status::DataState

Public Member Functions

 DataStateEx ()
 Create a DataStateEx with InstanceState::any(), ViewState::any(), SampleState::any(), and StreamKind::any(). More...
 
 DataStateEx (const StreamKind &the_stream_kind)
 Create a DataStateEx with InstanceState::any(), ViewState::any(), SampleState::any() and the provided StreamKind. More...
 
 DataStateEx (const dds::sub::status::DataState &the_data_state)
 Create a DataStateEx with the provided SampleState, ViewState, InstanceState, and StreamKind::any() More...
 
 DataStateEx (const dds::sub::status::DataState &the_data_state, const StreamKind &the_stream_kind)
 Create a DataStateEx with the provided SampleState, ViewState, InstanceState, and StreamKind. More...
 
DataStateExoperator<< (const StreamKind &the_stream_kind)
 Set the StreamKind. More...
 
const DataStateExoperator>> (StreamKind &the_stream_kind) const
 Get the StreamKind. More...
 
const StreamKindstream_kind () const
 Get the StreamKind. More...
 
void stream_kind (const StreamKind &the_stream_kind)
 Set the StreamKind. More...
 
const DataStatedata_state () const
 Access the view, sample and instance states. More...
 
bool operator== (const DataStateEx &other) const
 Compare two DataStateEx objects for equality. More...
 
bool operator!= (const DataStateEx &other) const
 Compare two DataStateEx objects for inequality. More...
 

Friends

void swap (DataStateEx &left, DataStateEx &right) OMG_NOEXCEPT
 Swap the contents of two DataState objects. More...
 

Additional Inherited Members

Detailed Description

<<extension>> <<value-type>> An extended version of dds::sub::status::DataState that also contains StreamKind

DataStateEx is an extension of DataState that allows setting an additional state mask: the StreamKind. It is used by rti::sub::cond::create_read_condition_ex and rti::sub::cond::create_query_condition_ex to create conditions that can filter based on the StreamKind.

A DataStateEx contains the state masks InstanceState, ViewState and SampleState (with the same getters and setters: instance_state(), view_state() and sample_state()).

In addition it contains the mask StreamKind with its getter and setter: stream_kind().

Constructor & Destructor Documentation

◆ DataStateEx() [1/4]

rti::sub::status::DataStateEx::DataStateEx ( )
inline

Create a DataStateEx with InstanceState::any(), ViewState::any(), SampleState::any(), and StreamKind::any().

◆ DataStateEx() [2/4]

rti::sub::status::DataStateEx::DataStateEx ( const StreamKind the_stream_kind)
inline

Create a DataStateEx with InstanceState::any(), ViewState::any(), SampleState::any() and the provided StreamKind.

Note that the constructor is implicit, so you can use a StreamKind wherever a DataStateEx is expected.

◆ DataStateEx() [3/4]

rti::sub::status::DataStateEx::DataStateEx ( const dds::sub::status::DataState the_data_state)
inline

Create a DataStateEx with the provided SampleState, ViewState, InstanceState, and StreamKind::any()

The constructor is implicit, so DataState can automatically be converted to a DataStateEx with StreamKind::any().

Parameters
the_data_stateContains the SampleState, ViewState and InstanceState

◆ DataStateEx() [4/4]

rti::sub::status::DataStateEx::DataStateEx ( const dds::sub::status::DataState the_data_state,
const StreamKind the_stream_kind 
)
inline

Create a DataStateEx with the provided SampleState, ViewState, InstanceState, and StreamKind.

Parameters
the_data_stateContains the SampleState, ViewState and InstanceState
the_stream_kindContains the StreamKind

Member Function Documentation

◆ operator<<()

DataStateEx& rti::sub::status::DataStateEx::operator<< ( const StreamKind the_stream_kind)
inline

Set the StreamKind.

◆ operator>>()

const DataStateEx& rti::sub::status::DataStateEx::operator>> ( StreamKind the_stream_kind) const
inline

Get the StreamKind.

◆ stream_kind() [1/2]

const StreamKind& rti::sub::status::DataStateEx::stream_kind ( ) const
inline

Get the StreamKind.

Referenced by operator==().

◆ stream_kind() [2/2]

void rti::sub::status::DataStateEx::stream_kind ( const StreamKind the_stream_kind)
inline

Set the StreamKind.

◆ data_state()

const DataState& rti::sub::status::DataStateEx::data_state ( ) const
inline

Access the view, sample and instance states.

Referenced by operator==().

◆ operator==()

bool rti::sub::status::DataStateEx::operator== ( const DataStateEx other) const
inline

Compare two DataStateEx objects for equality.

References data_state(), and stream_kind().

◆ operator!=()

bool rti::sub::status::DataStateEx::operator!= ( const DataStateEx other) const
inline

Compare two DataStateEx objects for inequality.

Friends And Related Function Documentation

◆ swap

void swap ( DataStateEx left,
DataStateEx right 
)
friend

Swap the contents of two DataState objects.