RTI Connext Modern C++ API
Version 6.0.1
|
The DataState class describes the state of a sample and includes the information about the sample's InstanceState, ViewState, and SampleState. More...
#include <dds/sub/status/DataState.hpp>
Public Member Functions | |
DataState () | |
Create a DataState with InstanceState::any(), ViewState::any(), and SampleState::any() | |
DataState (const SampleState &the_sample_state) | |
Create a DataState with InstanceState::any(), ViewState::any(), and the provided SampleState. | |
DataState (const ViewState &the_view_state) | |
Create a DataState with InstanceState::any(), SampleState::any(), and the provided ViewState. | |
DataState (const InstanceState &the_instance_state) | |
Create a DataState with SampleState::any(), ViewState::any(), and the provided InstanceState. | |
DataState (const SampleState &the_sample_state, const ViewState &the_view_state, const InstanceState &the_instance_state) | |
Create a DataState with the provided SampleState, ViewState, and InstanceState. | |
bool | operator== (const DataState &other) const |
Compare two DataState objects for equality. | |
bool | operator!= (const DataState &other) const |
Compare two DataState objects for inequality. | |
DataState & | operator<< (const SampleState &the_sample_state) |
Set the provided SampleState in a DataState object. | |
DataState & | operator<< (const InstanceState &the_instance_state) |
Set the provided InstanceState in a DataState object. | |
DataState & | operator<< (const ViewState &the_view_state) |
Set the provided ViewState in a DataState object. | |
const DataState & | operator>> (SampleState &the_sample_state) const |
Get the SampleState from a DataState object. | |
const DataState & | operator>> (InstanceState &the_instance_state) const |
Get the InstanceState from a DataState object. | |
const DataState & | operator>> (ViewState &the_view_state) const |
Get the ViewState from a DataState object. | |
const SampleState & | sample_state () const |
Get the SampleState from a DataState object. | |
void | sample_state (const SampleState &the_sample_state) |
Set the provided SampleState in a DataState object. | |
const InstanceState & | instance_state () const |
Get the InstanceState from a DataState object. | |
void | instance_state (const InstanceState &the_instance_state) |
Set the provided InstanceState in a DataState object. | |
const ViewState & | view_state () const |
Get the ViewState from a DataState object. | |
void | view_state (const ViewState &the_view_state) |
Set the provided ViewState in a DataState object. | |
Static Public Member Functions | |
static DataState | any () |
Create a DataState with InstanceState::any(), ViewState::any(), and SampleState::any() | |
static DataState | new_data () |
Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::not_read() | |
static DataState | any_data () |
Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::any() | |
static DataState | new_instance () |
Create a DataState with InstanceState::alive(), ViewState::new_view(), and SampleState::any() | |
Friends | |
void | swap (DataState &left, DataState &right) OMG_NOEXCEPT |
Swap the contents of two DataState objects. | |
The DataState class describes the state of a sample and includes the information about the sample's InstanceState, ViewState, and SampleState.
|
inline |
Create a DataState with InstanceState::any(), ViewState::any(), and SampleState::any()
|
inline |
Create a DataState with InstanceState::any(), ViewState::any(), and the provided SampleState.
Note that the constructor is implicit, so you can use a SampleState wherever a DataState is expected.
|
inline |
Create a DataState with InstanceState::any(), SampleState::any(), and the provided ViewState.
Note that the constructor is implicit, so you can use a ViewState wherever a DataState is expected.
|
inline |
Create a DataState with SampleState::any(), ViewState::any(), and the provided InstanceState.
Note that the constructor is implicit, so you can use a InstanceState wherever a DataState is expected.
|
inline |
Create a DataState with the provided SampleState, ViewState, and InstanceState.
|
inline |
Compare two DataState objects for equality.
|
inline |
Compare two DataState objects for inequality.
|
inline |
Set the provided SampleState in a DataState object.
|
inline |
Set the provided InstanceState in a DataState object.
|
inline |
Get the SampleState from a DataState object.
|
inline |
Get the InstanceState from a DataState object.
|
inline |
Get the SampleState from a DataState object.
|
inline |
Set the provided SampleState in a DataState object.
|
inline |
Get the InstanceState from a DataState object.
|
inline |
Set the provided InstanceState in a DataState object.
|
inline |
|
inline |
|
inlinestatic |
Create a DataState with InstanceState::any(), ViewState::any(), and SampleState::any()
|
inlinestatic |
Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::not_read()
|
inlinestatic |
Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::any()
|
inlinestatic |
Create a DataState with InstanceState::alive(), ViewState::new_view(), and SampleState::any()