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:

Public Member Functions
	DataStateEx ()
	Create a DataStateEx with InstanceState::any(), ViewState::any(), SampleState::any(), and StreamKind::any().
	DataStateEx (const StreamKind &the_stream_kind)
	Create a DataStateEx with InstanceState::any(), ViewState::any(), SampleState::any() and the provided StreamKind.
	DataStateEx (const dds::sub::status::DataState &the_data_state)
	Create a DataStateEx with the provided SampleState, ViewState, InstanceState, and StreamKind::any()
	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.
DataStateEx &	operator<< (const StreamKind &the_stream_kind)
	Set the StreamKind.
const DataStateEx &	operator>> (StreamKind &the_stream_kind) const
	Get the StreamKind.
const StreamKind &	stream_kind () const
	Get the StreamKind.
void	stream_kind (const StreamKind &the_stream_kind)
	Set the StreamKind.
const DataState &	data_state () const
	Access the view, sample and instance states.
bool	operator== (const DataStateEx &other) const
	Compare two DataStateEx objects for equality.
bool	operator!= (const DataStateEx &other) const
	Compare two DataStateEx objects for inequality.

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

Additional Inherited Members
Private Member Functions inherited from dds::sub::status::DataState
	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 Private Member Functions inherited from dds::sub::status::DataState
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()

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

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

inline

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

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.

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_state

Contains the SampleState, ViewState and InstanceState

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_state	Contains the SampleState, ViewState and InstanceState
the_stream_kind	Contains the StreamKind

Member Function Documentation

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

inline

Set the StreamKind.

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

inline

Get the StreamKind.

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

inline

Get the StreamKind.

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

inline

Set the StreamKind.

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

inline

Access the view, sample and instance states.

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

inline

Compare two DataStateEx objects for equality.

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

inline

Compare two DataStateEx objects for inequality.

Friends And Related Function Documentation

void swap ( DataStateEx &  left, DataStateEx &  right  )

friend

Swap the contents of two DataState objects.