18.1.1.4.19. StatusMask

class StatusMask : public std::bitset<FASTDDS_STATUS_COUNT>

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

Public Types

typedef std::bitset<FASTDDS_STATUS_COUNT> MaskType

Convenience typedef for std::bitset<FASTDDS_STATUS_COUNT>.

Public Functions

inline StatusMask()

Construct an StatusMask with no flags set.

inline explicit StatusMask(uint32_t mask)

Construct an StatusMask with an uint32_t bit mask.

Parameters

mask – the bit array to initialize the bitset with

inline StatusMask &operator<<(const StatusMask &mask)

Add given StatusMask bits into this StatusMask bitset.

Returns

StatusMask this

inline StatusMask &operator>>(const StatusMask &mask)

Remove given StatusMask bits into this StatusMask bitset.

Returns

StatusMask this

inline bool is_active(StatusMask status) const

Checks if the status passed as parameter is 1 in the actual StatusMask.

Parameters

status – Status that need to be checked

Returns

true if the status is active and false if not

Public Static Functions

static inline StatusMask all()

Get all StatusMasks

Returns

StatusMask all

static inline StatusMask none()

Get no StatusMasks

Returns

StatusMask none

static inline StatusMask inconsistent_topic()

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

Returns

StatusMask inconsistent_topic

static inline StatusMask offered_deadline_missed()

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

Returns

StatusMask offered_deadline_missed

static inline StatusMask requested_deadline_missed()

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

Returns

StatusMask requested_deadline_missed

static inline StatusMask offered_incompatible_qos()

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

Returns

StatusMask offered_incompatible_qos

static inline StatusMask requested_incompatible_qos()

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

Returns

StatusMask requested_incompatible_qos

static inline StatusMask sample_lost()

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

Returns

StatusMask sample_lost

static inline StatusMask sample_rejected()

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

Returns

StatusMask sample_rejected

static inline StatusMask data_on_readers()

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

Returns

StatusMask data_on_readers

static inline StatusMask data_available()

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

Returns

statusmask data_available

static inline StatusMask liveliness_lost()

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

Returns

StatusMask liveliness_lost

static inline StatusMask liveliness_changed()

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

Returns

StatusMask liveliness_changed

static inline StatusMask publication_matched()

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

Returns

StatusMask publication_matched

static inline StatusMask subscription_matched()

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

Returns

StatusMask subscription_matched

FASTDDS_STATUS_COUNT size_t(16)

Alias of size_t(16)