Class to hold sample DataState information. More...

#include "DataState.hpp"

Public Member Functions
	DataState ()

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

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

	DataState (const dds::sub::status::SampleState &ss, const dds::sub::status::ViewState &vs, const dds::sub::status::InstanceState &is)

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

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

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

bool	operator!= (const DataState &o) const

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

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

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

bool	operator== (const DataState &o) const

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

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

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

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

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

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

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

Static Public Member Functions
static DataState	any ()

static DataState	any_data ()

static DataState	new_data ()

static DataState	new_instance ()

Detailed Description

Class to hold sample DataState information.

The DataState is part of dds::sub::SampleInfo but can also be used as data filter for DataReaders.

The DataState contains the following:

The sample_state of the Data value (i.e., if the sample has already been READ or NOT_READ by that same DataReader).
The view_state of the related instance (i.e., if the instance is NEW, or NOT_NEW for that DataReader).
The instance_state of the related instance (i.e., if the instance is ALIVE, NOT_ALIVE_DISPOSED, or NOT_ALIVE_NO_WRITERS).

See also: SampleInfo for more information

Definition at line 371 of file DataState.hpp.

Constructor & Destructor Documentation

◆ DataState() [1/5]

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

inline

Create a DataState instance.

Construct a DataState with:

Definition at line 383 of file DataState.hpp.

◆ DataState() [2/5]

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

inline

Create a DataState instance.

Construct a DataState with:

Parameters

ss	the SampleState to construct DataState from

Definition at line 399 of file DataState.hpp.

◆ DataState() [3/5]

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

inline

Create a DataState instance.

Construct a DataState with:

Parameters

vs	the ViewState to construct DataState from

Definition at line 415 of file DataState.hpp.

◆ DataState() [4/5]

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

inline

Create a DataState instance.

Construct a DataState with:

Parameters

is	InstanceState to construct DataState from

Definition at line 431 of file DataState.hpp.

◆ DataState() [5/5]

dds::sub::status::DataState::DataState	(	const dds::sub::status::SampleState &	ss,
		const dds::sub::status::ViewState &	vs,
		const dds::sub::status::InstanceState &	is
	)

inline

Create a DataState instance.

Construct a DataState with:

Given SampleState ss
Given ViewState vs
Given InstanceState is

Parameters

ss	SampleState
vs	ViewState
is	InstanceState

Definition at line 449 of file DataState.hpp.

Member Function Documentation

◆ any()

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

inlinestatic

Create a DataState instance.

Return a DataState with:

Returns: the any DataState

Definition at line 614 of file DataState.hpp.

◆ any_data()

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

inlinestatic

Create a DataState instance.

Return a DataState with:

Returns: the any_data DataState

Definition at line 648 of file DataState.hpp.

◆ instance_state() [1/2]

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

inline

Get InstanceState.

Returns: the InstanceState

Definition at line 569 of file DataState.hpp.

◆ instance_state() [2/2]

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

inline

Set InstanceState.

Parameters

is	InstanceState

Definition at line 579 of file DataState.hpp.

◆ new_data()

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

inlinestatic

Create a DataState instance.

Return a DataState with:

Returns: the new_data DataState

Definition at line 631 of file DataState.hpp.

◆ new_instance()

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

inlinestatic

Create a DataState instance.

Return a DataState with:

Returns: the new_instance DataState

Definition at line 665 of file DataState.hpp.

◆ operator!=()

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

inline

Check if this DataState is not equal with another

Returns: true if not equal

Definition at line 539 of file DataState.hpp.

◆ operator<<() [1/3]

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

inline

Set InstanceState.

Parameters

is	InstanceState

Definition at line 471 of file DataState.hpp.

◆ operator<<() [2/3]

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

inline

Set SampleState.

Parameters

ss	SampleState

Definition at line 460 of file DataState.hpp.

◆ operator<<() [3/3]

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

inline

Set ViewState.

Parameters

vs ViewState

Definition at line 482 of file DataState.hpp.

◆ operator==()

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

inline

Check if this DataState is equal with another

Returns: true if equal

Definition at line 529 of file DataState.hpp.

◆ operator>>() [1/3]

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

inline

Get InstanceState.

Parameters

is	InstanceState

Returns: the DataState

Definition at line 506 of file DataState.hpp.

◆ operator>>() [2/3]

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

inline

Get SampleState.

Parameters

ss	SampleState

Returns: the DataState

Definition at line 494 of file DataState.hpp.

◆ operator>>() [3/3]

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

inline

Get ViewState.

Parameters

vs ViewState

Returns: the DataState

Definition at line 518 of file DataState.hpp.

◆ sample_state() [1/2]

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

inline

Get SampleState.

Returns: the SampleState

Definition at line 549 of file DataState.hpp.

◆ sample_state() [2/2]

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

inline

Set SampleState.

Parameters

ss	SampleState

Definition at line 559 of file DataState.hpp.

◆ view_state() [1/2]

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

inline

Get ViewState.

Returns: the ViewState

Definition at line 589 of file DataState.hpp.

◆ view_state() [2/2]

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

inline

Set ViewState.

Parameters

vs ViewState

Definition at line 599 of file DataState.hpp.

The documentation for this class was generated from the following file:

dds/sub/status/DataState.hpp

Public Member Functions

Static Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ DataState() [1/5]

◆ DataState() [2/5]

◆ DataState() [3/5]

◆ DataState() [4/5]

◆ DataState() [5/5]

Member Function Documentation

◆ any()

◆ any_data()

◆ instance_state() [1/2]

◆ instance_state() [2/2]

◆ new_data()

◆ new_instance()

◆ operator!=()

◆ operator<<() [1/3]

◆ operator<<() [2/3]

◆ operator<<() [3/3]

◆ operator==()

◆ operator>>() [1/3]

◆ operator>>() [2/3]

◆ operator>>() [3/3]

◆ sample_state() [1/2]

◆ sample_state() [2/2]

◆ view_state() [1/2]

◆ view_state() [2/2]