dds::core::status::StatusMask Class Reference

StatusMask is a bitmap or bitset field. More...

#include "State.hpp"

Inherits std::bitset< Bits >.

Public Types
typedef std::bitset< OMG_DDS_STATUS_COUNT >	MaskType

Public Member Functions
	StatusMask ()
	StatusMask (const StatusMask &other)
	StatusMask (uint32_t mask)
StatusMask &	operator<< (const dds::core::status::StatusMask &mask)

Static Public Member Functions
static StatusMask	all ()
static StatusMask	data_available ()
static StatusMask	data_on_readers ()
static StatusMask	inconsistent_topic ()
static StatusMask	liveliness_changed ()
static StatusMask	liveliness_lost ()
static StatusMask	none ()
static StatusMask	offered_deadline_missed ()
static StatusMask	offered_incompatible_qos ()
static StatusMask	publication_matched ()
static StatusMask	requested_deadline_missed ()
static StatusMask	requested_incompatible_qos ()
static StatusMask	sample_lost ()
static StatusMask	sample_rejected ()
static StatusMask	subscription_matched ()

Detailed Description

StatusMask is a bitmap or bitset field.

This bitset is used to:

• determine which listener functions to call
• set conditions in dds::core::cond::StatusCondition
• indicate status changes when calling dds::core::Entity::status_changes

See also

Status concept

Definition at line 144 of file State.hpp.

Member Typedef Documentation

MaskType

typedef std::bitset<OMG_DDS_STATUS_COUNT> dds::core::status::StatusMask::MaskType

Convenience typedef for std::bitset<OMG_DDS_STATE_BIT_COUNT>.

Definition at line 150 of file State.hpp.

Constructor & Destructor Documentation

StatusMask() [1/3]

dds::core::status::StatusMask::StatusMask

(

)

Construct an StatusMask with no flags set.

StatusMask() [2/3]

dds::core::status::StatusMask::StatusMask ( uint32_t  mask )

explicit

Construct an StatusMask with an uint32_t bit mask.

Parameters

mask	the bit array to initialize the bitset with

StatusMask() [3/3]

dds::core::status::StatusMask::StatusMask

(

const StatusMask &

other

)

Copy constructor.

Construct an StatusMask with existing StatusMask.

Parameters

other

the StatusMask to copy from

Member Function Documentation

all()

static StatusMask dds::core::status::StatusMask::all ( )

inlinestatic

Get all StatusMasks

Returns

StatusMask all

Definition at line 195 of file State.hpp.

data_available()

static StatusMask dds::core::status::StatusMask::data_available ( )

inlinestatic

get the statusmask associated with dds::core::status::data_available

Returns

statusmask data_available

Definition at line 296 of file State.hpp.

data_on_readers()

static StatusMask dds::core::status::StatusMask::data_on_readers ( )

inlinestatic

Get the StatusMask associated with dds::core::status::data_on_readers

Returns

StatusMask data_on_readers

Definition at line 286 of file State.hpp.

inconsistent_topic()

static StatusMask dds::core::status::StatusMask::inconsistent_topic ( )

inlinestatic

Get the StatusMask associated with dds::core::status::InconsistentTopicStatus

Returns

StatusMask inconsistent_topic

Definition at line 216 of file State.hpp.

liveliness_changed()

static StatusMask dds::core::status::StatusMask::liveliness_changed ( )

inlinestatic

Get the StatusMask associated with dds::core::status::LivelinessChangedStatus

Returns

StatusMask liveliness_changed

Definition at line 316 of file State.hpp.

liveliness_lost()

static StatusMask dds::core::status::StatusMask::liveliness_lost ( )

inlinestatic

Get the StatusMask associated with dds::core::status::LivelinessLostStatus

Returns

StatusMask liveliness_lost

Definition at line 306 of file State.hpp.

none()

static StatusMask dds::core::status::StatusMask::none ( )

inlinestatic

Get no StatusMasks

Returns

StatusMask none

Definition at line 205 of file State.hpp.

offered_deadline_missed()

static StatusMask dds::core::status::StatusMask::offered_deadline_missed ( )

inlinestatic

Get the StatusMask associated with dds::core::status::OfferedDeadlineMissedStatus

Returns

StatusMask offered_deadline_missed

Definition at line 226 of file State.hpp.

offered_incompatible_qos()

static StatusMask dds::core::status::StatusMask::offered_incompatible_qos ( )

inlinestatic

Get the StatusMask associated with dds::core::status::OfferedIncompatibleQosStatus

Returns

StatusMask offered_incompatible_qos

Definition at line 246 of file State.hpp.

operator<<()

StatusMask& dds::core::status::StatusMask::operator<< ( const dds::core::status::StatusMask &  mask )

inline

Shift (merge) given StatusMask bits into this StatusMask bitset.

Returns

StatusMask this

Definition at line 184 of file State.hpp.

publication_matched()

static StatusMask dds::core::status::StatusMask::publication_matched ( )

inlinestatic

Get the statusmask associated with dds::core::status::PublicationMatchedStatus

Returns

StatusMask publication_matched

Definition at line 326 of file State.hpp.

requested_deadline_missed()

static StatusMask dds::core::status::StatusMask::requested_deadline_missed ( )

inlinestatic

Get the StatusMask associated with dds::core::status::RequestedDeadlineMissedStatus

Returns

StatusMask requested_deadline_missed

Definition at line 236 of file State.hpp.

requested_incompatible_qos()

static StatusMask dds::core::status::StatusMask::requested_incompatible_qos ( )

inlinestatic

Get the StatusMask associated with dds::core::status::RequestedIncompatibleQosStatus

Returns

StatusMask requested_incompatible_qos

Definition at line 256 of file State.hpp.

sample_lost()

static StatusMask dds::core::status::StatusMask::sample_lost ( )

inlinestatic

Get the StatusMask associated with dds::core::status::SampleLostStatus

Returns

StatusMask sample_lost

Definition at line 266 of file State.hpp.

sample_rejected()

static StatusMask dds::core::status::StatusMask::sample_rejected ( )

inlinestatic

Get the StatusMask associated with dds::core::status::SampleRejectedStatus

Returns

StatusMask sample_rejected

Definition at line 276 of file State.hpp.

subscription_matched()

static StatusMask dds::core::status::StatusMask::subscription_matched ( )

inlinestatic

Get the statusmask associated with dds::core::status::SubscriptionMatchedStatus

Returns

StatusMask subscription_matched

Definition at line 336 of file State.hpp.

---

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

• dds/core/status/State.hpp