RTI Connext Modern C++ API
Version 6.1.0
|
<<extension>> <<value-type>> An extended version of dds::sub::status::DataState that also contains StreamKind More...
#include <DataStateEx.hpp>
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... | |
DataStateEx & | operator<< (const StreamKind &the_stream_kind) |
Set the StreamKind. More... | |
const DataStateEx & | operator>> (StreamKind &the_stream_kind) const |
Get the StreamKind. More... | |
const StreamKind & | stream_kind () const |
Get the StreamKind. More... | |
void | stream_kind (const StreamKind &the_stream_kind) |
Set the StreamKind. More... | |
const DataState & | data_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 | |
![]() | |
std::ostream & | operator<< (std::ostream &os, const DataState &s) |
Prints a data state as a readable string. More... | |
<<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().
|
inline |
Create a DataStateEx with InstanceState::any(), ViewState::any(), SampleState::any(), and StreamKind::any().
|
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.
|
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().
the_data_state | Contains the SampleState, ViewState and InstanceState |
|
inline |
Create a DataStateEx with the provided SampleState, ViewState, InstanceState, and StreamKind.
the_data_state | Contains the SampleState, ViewState and InstanceState |
the_stream_kind | Contains the StreamKind |
|
inline |
Set the StreamKind.
|
inline |
Get the StreamKind.
|
inline |
Get the StreamKind.
Referenced by operator==().
|
inline |
Set the StreamKind.
|
inline |
Access the view, sample and instance states.
Referenced by operator==().
|
inline |
Compare two DataStateEx objects for equality.
References data_state(), and stream_kind().
|
inline |
Compare two DataStateEx objects for inequality.
|
friend |
Swap the contents of two DataState objects.