dds::sub::status::SampleState Class Reference

Indicates whether or not a sample has ever been read. More...

#include <dds/sub/status/DataState.hpp>

Inherits bitset< OMG_DDS_STATE_BIT_COUNT >.

Public Types
typedef std::bitset < OMG_DDS_STATE_BIT_COUNT >	MaskType
	An std::bitset of SampleStates.

Public Member Functions
	SampleState (const MaskType &other)
	Create an SampleState from MaskType.

Static Public Member Functions
static const SampleState	read ()
	Creates a read SampleState.
static const SampleState	not_read ()
	Creates a not_read SampleState object.
static const SampleState	any ()
	Creates a SampleState object representing any sample state.

Detailed Description

Indicates whether or not a sample has ever been read.

Member Typedef Documentation

typedef std::bitset<OMG_DDS_STATE_BIT_COUNT > dds::sub::status::SampleState::MaskType

An std::bitset of SampleStates.

Constructor & Destructor Documentation

dds::sub::status::SampleState::SampleState ( const MaskType &  other )

inline

Create an SampleState from MaskType.

Parameters

other

The MaskType to create the SampleState with

Member Function Documentation

static const SampleState dds::sub::status::SampleState::read ( )

inlinestatic

Creates a read SampleState.

A read SampleState indicates that the dds::sub::DataReader has already accessed that sample by means of a read or take operation.

static const SampleState dds::sub::status::SampleState::not_read ( )

inlinestatic

Creates a not_read SampleState object.

A not_read SampleState indicates that the dds::sub::DataReader has not accessed that sample before.

static const SampleState dds::sub::status::SampleState::any ( )

inlinestatic

Creates a SampleState object representing any sample state.