dds::sub::status::DataState Class Reference

The DataState class describes the state of a sample. More...

Public Member Functions
	DataState ()
	Construct a DataState with SampleState, ViewState, and InstanceState all set to 'any'.
	DataState (const dds::sub::status::SampleState &ss)
	Construct a DataState with the provided SampleState. More...
	DataState (const dds::sub::status::ViewState &vs)
	Construct a DataState with the provided ViewState. More...
	DataState (const dds::sub::status::InstanceState &is)
	Construct a DataState with the provided InstanceState. More...
	DataState (const dds::sub::status::SampleState &ss, const dds::sub::status::ViewState &vs, const dds::sub::status::InstanceState &is)
	Construct a DataState with the provided SampleState, ViewState, and InstanceState.
bool	operator== (const DataState &other) const
	Compare this DataState to the provided other.
bool	operator!= (const DataState &other) const
	Compare this DataState to the provided other.
DataState &	operator<< (const dds::sub::status::SampleState &ss)
	Assign the SampleState in this DataState.
DataState &	operator<< (const dds::sub::status::InstanceState &is)
	Assign the InstanceState in this DataState.
DataState &	operator<< (const dds::sub::status::ViewState &vs)
	Assign the ViewState in this DataState.
const DataState &	operator>> (dds::sub::status::SampleState &ss) const
	Get the SampleState from this DataState.
const DataState &	operator>> (dds::sub::status::InstanceState &is) const
	Get the InstanceState from this DataState.
const DataState &	operator>> (dds::sub::status::ViewState &vs) const
	Get the ViewState from this DataState.
const dds::sub::status::SampleState &	sample_state () const
	Get the SampleState from this DataState.
void	sample_state (const dds::sub::status::SampleState &ss)
	Assign the SampleState in this DataState.
const dds::sub::status::InstanceState &	instance_state () const
	Get the InstanceState from this DataState.
void	instance_state (const dds::sub::status::InstanceState &is)
	Assign the InstanceState in this DataState.
const dds::sub::status::ViewState &	view_state () const
	Get the ViewState from this DataState.
void	view_state (const dds::sub::status::ViewState &vs)
	Assign the ViewState in this DataState.

Static Public Member Functions
static DataState	any ()
	Construct a DataState with SampleState, ViewState, and InstanceState all set to 'any'.
static DataState	new_data ()
	Construct a DataState with SampleState = not_read(), ViewState, and InstanceState set to 'any'.
static DataState	any_data ()
	Construct a DataState with SampleState = any(), ViewState = any(), and InstanceState = alive()
static DataState	new_instance ()
	Construct a DataState with SampleState = any(), ViewState = new_view(), and InstanceState = alive()
static DataState	alive ()
	Construct a DataState with SampleState = any(), ViewState = any(), and InstanceState = alive() .
static DataState	not_alive ()
	Construct a DataState with SampleState = any(), ViewState = any(), and InstanceState = not_alive_mask() .

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, const dds::sub::status::DataState &s)

Detailed Description

The DataState class describes the state of a sample.

It includes the information about the sample's SampleState, ViewState, and InstanceState.

Constructor & Destructor Documentation

DataState() [1/3]

dds::sub::status::DataState::DataState ( const dds::sub::status::SampleState &  ss )

inline

Construct a DataState with the provided SampleState.

ViewState, and InstanceState are set to 'any'

DataState() [2/3]

dds::sub::status::DataState::DataState ( const dds::sub::status::ViewState &  vs )

inline

Construct a DataState with the provided ViewState.

SampleState, and InstanceState are set to 'any'

DataState() [3/3]

dds::sub::status::DataState::DataState ( const dds::sub::status::InstanceState &  is )

inline

Construct a DataState with the provided InstanceState.

SampleState, and ViewState are set to 'any'

Friends And Related Function Documentation

operator<<()

std::ostream & operator<< ( std::ostream &  os, const dds::sub::status::DataState &  s  )

related

Generate a string representation of the DataState contents