dds::sub::status::InstanceState Class Reference

Class to hold sample InstanceState information. More...

#include "DataState.hpp"

Inherits std::bitset< Bits >.

Public Types
typedef std::bitset< OMG_DDS_STATE_BIT_COUNT >	MaskType

Public Member Functions
	InstanceState ()
	InstanceState (const InstanceState &src)
	InstanceState (const MaskType &src)
	InstanceState (uint32_t m)

Static Public Member Functions
static const InstanceState	alive ()
static const InstanceState	any ()
static const InstanceState	not_alive_disposed ()
static const InstanceState	not_alive_mask ()
static const InstanceState	not_alive_no_writers ()

Detailed Description

Class to hold sample InstanceState information.

For each instance the Data Distribution Service internally maintains an InstanceState. The InstanceState can be:

• alive, which indicates that
  • samples have been received for the instance
  • there are live DataWriter objects writing the instance
  • the instance has not been explicitly disposed of (or else samples have been received after it was disposed of)
• not_alive_disposed, which indicates that
  • the instance was disposed of by a DataWriter, either explicitly by means of the dispose operation or implicitly in case the autodispose_unregistered_instances field of the WriterDataLyfecycle QosPolicy equals TRUE when the instance gets unregistered, WriterDataLifecycle QosPolicy and no new samples for that instance have been written afterwards.
• not_alive_no_writers, which indicates that
  • the instance has been declared as not-alive by the DataReader because it detected that there are no live DataWriter objects writing that instance.

See also

SampleInfo for more information

Definition at line 246 of file DataState.hpp.

Member Typedef Documentation

MaskType

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

Convenience typedef for std::bitset<OMG_DDS_STATE_BIT_COUNT>.

Definition at line 252 of file DataState.hpp.

Constructor & Destructor Documentation

InstanceState() [1/4]

dds::sub::status::InstanceState::InstanceState

(

)

Construct an InstanceState with no state flags set.

InstanceState() [2/4]

dds::sub::status::InstanceState::InstanceState ( uint32_t  m )

explicit

Construct an InstanceState with an uint32_t m, representing a bit array.

Parameters

m	the bit array to initialize the bitset with

InstanceState() [3/4]

dds::sub::status::InstanceState::InstanceState

(

const InstanceState &

src

)

Copy constructor.

Construct an InstanceState with existing InstanceState.

Parameters

src	the InstanceState to copy from

InstanceState() [4/4]

dds::sub::status::InstanceState::InstanceState

(

const MaskType &

src

)

Construct an InstanceState with existing MaskType.

Parameters

src	the bitset to copy from

Member Function Documentation

alive()

static const InstanceState dds::sub::status::InstanceState::alive ( )

inlinestatic

Get ALIVE_INSTANCE_STATE.

alive, which indicates that

• samples have been received for the instance
• there are live DataWriter objects writing the instance
• the instance has not been explicitly disposed of (or else samples have been received after it was disposed of)

Returns

the alive InstanceState

any()

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

inlinestatic

Get any InstanceState.

This Instance is either in existence or not in existence.

Returns

the any InstanceState

not_alive_disposed()

static const InstanceState dds::sub::status::InstanceState::not_alive_disposed ( )

inlinestatic

Get NOT_ALIVE_DISPOSED_INSTANCE_STATE.

not_alive_disposed, which indicates that

• the instance was disposed of by a DataWriter, either explicitly by means of the dispose operation or implicitly in case the autodispose_unregistered_instances field of the WriterDataLyfecycle QosPolicy equals TRUE when the instance gets unregistered, WriterDataLifecycle QosPolicy and no new samples for that instance have been written afterwards.

Returns

the not_alive_disposed InstanceState

not_alive_mask()

static const InstanceState dds::sub::status::InstanceState::not_alive_mask ( )

inlinestatic

Get not_alive mask

not_alive = not_alive_disposed | not_alive_no_writers:

• not_alive_disposed, which indicates that
  • the instance was disposed of by a DataWriter, either explicitly by means of the dispose operation or implicitly in case the autodispose_unregistered_instances field of the WriterDataLyfecycle QosPolicy equals TRUE when the instance gets unregistered, WriterDataLifecycle QosPolicy and no new samples for that instance have been written afterwards.
• not_alive_no_writers, which indicates that
  • the instance has been declared as not-alive by the DataReader because it detected that there are no live DataWriter objects writing that instance.

Returns

the not_alive_mask InstanceState

not_alive_no_writers()

static const InstanceState dds::sub::status::InstanceState::not_alive_no_writers ( )

inlinestatic

Get NOT_ALIVE_NO_WRITERS_INSTANCE_STATE.

not_alive_no_writers, which indicates that

• the instance has been declared as not-alive by the DataReader because it detected that there are no live DataWriter objects writing that instance.

Returns

the not_alive_no_writers InstanceState

---

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

• dds/sub/status/DataState.hpp