<<extension>> <<value-type>> An extended version of dds::sub::status::DataState that also contains StreamKind
More...
#include <DataStateEx.hpp>
|
| 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...
|
|
const SampleState & | sample_state () const |
| Access the SampleState. More...
|
|
void | sample_state (const SampleState &the_sample_state) |
| Access the SampleState. More...
|
|
const ViewState & | view_state () const |
| Access the ViewState. More...
|
|
void | view_state (const ViewState &the_view_state) |
| Access the ViewState. More...
|
|
const InstanceState & | instance_state () const |
| Access the InstanceState. More...
|
|
void | instance_state (const InstanceState &the_instance_state) |
| Access the InstanceState. More...
|
|
|
static DataState | any () |
| Create a DataState with InstanceState::any(), ViewState::any(), and SampleState::any() More...
|
|
static DataState | new_data () |
| Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::not_read() More...
|
|
static DataState | any_data () |
| Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::any() More...
|
|
static DataState | new_instance () |
| Create a DataState with InstanceState::alive(), ViewState::new_view(), and SampleState::any() 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().
◆ DataStateEx() [1/4]
rti::sub::status::DataStateEx::DataStateEx |
( |
| ) |
|
|
inline |
◆ 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]
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_state | Contains the SampleState, ViewState and InstanceState |
◆ DataStateEx() [4/4]
Create a DataStateEx with the provided SampleState, ViewState, InstanceState, and StreamKind.
- Parameters
-
the_data_state | Contains the SampleState, ViewState and InstanceState |
the_stream_kind | Contains the StreamKind |
◆ operator<<()
◆ operator>>()
◆ stream_kind() [1/2]
const StreamKind & rti::sub::status::DataStateEx::stream_kind |
( |
| ) |
const |
|
inline |
◆ stream_kind() [2/2]
void rti::sub::status::DataStateEx::stream_kind |
( |
const StreamKind & |
the_stream_kind | ) |
|
|
inline |
◆ 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 |
◆ operator!=()
bool rti::sub::status::DataStateEx::operator!= |
( |
const DataStateEx & |
other | ) |
const |
|
inline |
◆ sample_state() [1/2]
const SampleState & dds::sub::status::DataState::sample_state |
( |
| ) |
const |
|
inline |
◆ sample_state() [2/2]
void dds::sub::status::DataState::sample_state |
( |
const SampleState & |
the_sample_state | ) |
|
|
inline |
◆ view_state() [1/2]
const ViewState & dds::sub::status::DataState::view_state |
( |
| ) |
const |
|
inline |
◆ view_state() [2/2]
void dds::sub::status::DataState::view_state |
( |
const ViewState & |
the_view_state | ) |
|
|
inline |
◆ instance_state() [1/2]
const InstanceState & dds::sub::status::DataState::instance_state |
( |
| ) |
const |
|
inline |
Access the InstanceState.
◆ instance_state() [2/2]
void dds::sub::status::DataState::instance_state |
( |
const InstanceState & |
the_instance_state | ) |
|
|
inline |
Access the InstanceState.
◆ any()
static DataState dds::sub::status::DataState::any |
( |
| ) |
|
|
inlinestatic |
Create a DataState with InstanceState::any(), ViewState::any(), and SampleState::any()
◆ new_data()
static DataState dds::sub::status::DataState::new_data |
( |
| ) |
|
|
inlinestatic |
Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::not_read()
◆ any_data()
static DataState dds::sub::status::DataState::any_data |
( |
| ) |
|
|
inlinestatic |
Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::any()
◆ new_instance()
static DataState dds::sub::status::DataState::new_instance |
( |
| ) |
|
|
inlinestatic |
Create a DataState with InstanceState::alive(), ViewState::new_view(), and SampleState::any()
◆ swap
Swap the contents of two DataState objects.