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

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 &sample_state)
	Create a DataState with InstanceState::any(), ViewState::any(), and the provided SampleState.
	DataState (const ViewState &view_state)
	Create a DataState with InstanceState::any(), SampleState::any(), and the provided ViewState.
	DataState (const InstanceState &instance_state)
	Create a DataState with SampleState::any(), ViewState::any(), and the provided InstanceState.
	DataState (const SampleState &sample_state, const ViewState &view_state, const InstanceState &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 &sample_state)
	Set the provided SampleState in a DataState object.
DataState &	operator<< (const InstanceState &instance_state)
	Set the provided InstanceState in a DataState object.
DataState &	operator<< (const ViewState &view_state)
	Set the provided ViewState in a DataState object.
const DataState &	operator>> (SampleState &sample_state) const
	Get the SampleState from a DataState object.
const DataState &	operator>> (InstanceState &instance_state) const
	Get the InstanceState from a DataState object.
const DataState &	operator>> (ViewState &view_state) const
	Get the ViewState from a DataState object.
const SampleState &	sample_state () const
	Get the SampleState from a DataState object.
const void	sample_state (const SampleState &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 &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 &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.

Detailed Description

The DataState class describes the state of a sample and includes the information about the sample's InstanceState, ViewState, and SampleState.

Constructor & Destructor Documentation

dds::sub::status::DataState::DataState ( )

inline

Create a DataState with InstanceState::any(), ViewState::any(), and SampleState::any()

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

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.

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

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.

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

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.

dds::sub::status::DataState::DataState ( const SampleState &  sample_state, const ViewState &  view_state, const InstanceState &  instance_state  )

inline

Create a DataState with the provided SampleState, ViewState, and InstanceState.

Member Function Documentation

bool dds::sub::status::DataState::operator== ( const DataState &  other ) const

inline

Compare two DataState objects for equality.

bool dds::sub::status::DataState::operator!= ( const DataState &  other ) const

inline

Compare two DataState objects for inequality.

DataState& dds::sub::status::DataState::operator<< ( const SampleState &  sample_state )

inline

Set the provided SampleState in a DataState object.

DataState& dds::sub::status::DataState::operator<< ( const InstanceState &  instance_state )

inline

Set the provided InstanceState in a DataState object.

DataState& dds::sub::status::DataState::operator<< ( const ViewState &  view_state )

inline

Set the provided ViewState in a DataState object.

const DataState& dds::sub::status::DataState::operator>> ( SampleState &  sample_state ) const

inline

Get the SampleState from a DataState object.

const DataState& dds::sub::status::DataState::operator>> ( InstanceState &  instance_state ) const

inline

Get the InstanceState from a DataState object.

const DataState& dds::sub::status::DataState::operator>> ( ViewState &  view_state ) const

inline

Get the ViewState from a DataState object.

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

inline

Get the SampleState from a DataState object.

const void dds::sub::status::DataState::sample_state ( const SampleState &  sample_state )

inline

Set the provided SampleState in a DataState object.

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

inline

Get the InstanceState from a DataState object.

void dds::sub::status::DataState::instance_state ( const InstanceState &  instance_state )

inline

Set the provided InstanceState in a DataState object.

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

inline

Get the ViewState from a DataState object.

void dds::sub::status::DataState::view_state ( const ViewState &  view_state )

inline

Set the provided ViewState in a DataState object.

static DataState dds::sub::status::DataState::any ( )

inlinestatic

Create a DataState with InstanceState::any(), ViewState::any(), and SampleState::any()

Examples:

Foo_subscriber.cxx.

static DataState dds::sub::status::DataState::new_data ( )

inlinestatic

Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::not_read()

static DataState dds::sub::status::DataState::any_data ( )

inlinestatic

Create a DataState with InstanceState::alive(), ViewState::any(), and SampleState::any()

static DataState dds::sub::status::DataState::new_instance ( )

inlinestatic

Create a DataState with InstanceState::alive(), ViewState::new_view(), and SampleState::any()

Friends And Related Function Documentation

void swap ( DataState &  left, DataState &  right  )

friend

Swap the contents of two DataState objects.