14.1.1.4.18. StatusMask

class eprosima::fastdds::dds::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

StatusMask()

Construct an StatusMask with no flags set.

StatusMask(uint32_t mask)

Construct an StatusMask with an uint32_t bit mask.

Parameters
  • mask: the bit array to initialize the bitset with

StatusMask &operator<<(const StatusMask &mask)

Add given StatusMask bits into this StatusMask bitset.

Return

StatusMask this

StatusMask &operator>>(const StatusMask &mask)

Remove given StatusMask bits into this StatusMask bitset.

Return

StatusMask this

bool is_active(StatusMask status) const

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

Return

true if the status is active and false if not

Parameters
  • status: Status that need to be checked

Public Static Functions

StatusMask all()

Get all StatusMasks

Return

StatusMask all

StatusMask none()

Get no StatusMasks

Return

StatusMask none

StatusMask inconsistent_topic()

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

Return

StatusMask inconsistent_topic

StatusMask offered_deadline_missed()

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

Return

StatusMask offered_deadline_missed

StatusMask requested_deadline_missed()

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

Return

StatusMask requested_deadline_missed

StatusMask offered_incompatible_qos()

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

Return

StatusMask offered_incompatible_qos

StatusMask requested_incompatible_qos()

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

Return

StatusMask requested_incompatible_qos

StatusMask sample_lost()

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

Return

StatusMask sample_lost

StatusMask sample_rejected()

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

Return

StatusMask sample_rejected

StatusMask data_on_readers()

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

Return

StatusMask data_on_readers

StatusMask data_available()

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

Return

statusmask data_available

StatusMask liveliness_lost()

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

Return

StatusMask liveliness_lost

StatusMask liveliness_changed()

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

Return

StatusMask liveliness_changed

StatusMask publication_matched()

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

Return

StatusMask publication_matched

StatusMask subscription_matched()

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

Return

StatusMask subscription_matched

FASTDDS_STATUS_COUNT

Alias of size_t(16)