Fast DDS  Version 3.0.1
Fast DDS
Loading...
Searching...
No Matches
StatusMask Class Reference

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

#include <StatusMask.hpp>

Inheritance diagram for StatusMask:

Public Types

typedef std::bitset< FASTDDS_STATUS_COUNT > MaskType
 Convenience typedef for std::bitset<FASTDDS_STATUS_COUNT>.
 

Public Member Functions

 StatusMask ()
 Construct an StatusMask with no flags set.
 
 StatusMask (uint32_t mask)
 Construct an StatusMask with an uint32_t bit mask.
 
StatusMaskoperator<< (const StatusMask &mask)
 Add given StatusMask bits into this StatusMask bitset.
 
StatusMaskoperator>> (const StatusMask &mask)
 Remove given StatusMask bits into this StatusMask bitset.
 
bool is_active (StatusMask status) const
 Checks if the status passed as parameter is 1 in the actual StatusMask.
 

Static Public Member Functions

static StatusMask all ()
 Get all StatusMasks.
 
static StatusMask none ()
 Get no StatusMasks.
 
static StatusMask inconsistent_topic ()
 Get the StatusMask associated with dds::core::status::InconsistentTopicStatus.
 
static StatusMask offered_deadline_missed ()
 Get the StatusMask associated with dds::core::status::OfferedDeadlineMissedStatus.
 
static StatusMask requested_deadline_missed ()
 Get the StatusMask associated with dds::core::status::RequestedDeadlineMissedStatus.
 
static StatusMask offered_incompatible_qos ()
 Get the StatusMask associated with dds::core::status::OfferedIncompatibleQosStatus.
 
static StatusMask requested_incompatible_qos ()
 Get the StatusMask associated with dds::core::status::RequestedIncompatibleQosStatus.
 
static StatusMask sample_lost ()
 Get the StatusMask associated with dds::core::status::SampleLostStatus.
 
static StatusMask sample_rejected ()
 Get the StatusMask associated with dds::core::status::SampleRejectedStatus.
 
static StatusMask data_on_readers ()
 Get the StatusMask associated with dds::core::status::data_on_readers.
 
static StatusMask data_available ()
 get the statusmask associated with dds::core::status::data_available
 
static StatusMask liveliness_lost ()
 Get the StatusMask associated with dds::core::status::LivelinessLostStatus.
 
static StatusMask liveliness_changed ()
 Get the StatusMask associated with dds::core::status::LivelinessChangedStatus.
 
static StatusMask publication_matched ()
 Get the statusmask associated with dds::core::status::PublicationMatchedStatus.
 
static StatusMask subscription_matched ()
 Get the statusmask associated with dds::core::status::SubscriptionMatchedStatus.
 

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

Member Typedef Documentation

◆ MaskType

typedef std::bitset<FASTDDS_STATUS_COUNT> MaskType

Convenience typedef for std::bitset<FASTDDS_STATUS_COUNT>.

Constructor & Destructor Documentation

◆ StatusMask() [1/2]

StatusMask ( )
inline

Construct an StatusMask with no flags set.

◆ StatusMask() [2/2]

StatusMask ( uint32_t  mask)
inlineexplicit

Construct an StatusMask with an uint32_t bit mask.

Parameters
maskthe bit array to initialize the bitset with

Member Function Documentation

◆ all()

static StatusMask all ( )
inlinestatic

Get all StatusMasks.

Returns
StatusMask all

◆ data_available()

static StatusMask data_available ( )
inlinestatic

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

Returns
statusmask data_available

◆ data_on_readers()

static StatusMask data_on_readers ( )
inlinestatic

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

Returns
StatusMask data_on_readers

◆ inconsistent_topic()

static StatusMask inconsistent_topic ( )
inlinestatic

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

Returns
StatusMask inconsistent_topic

◆ is_active()

bool is_active ( StatusMask  status) const
inline

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

Parameters
statusStatus that need to be checked
Returns
true if the status is active and false if not

◆ liveliness_changed()

static StatusMask liveliness_changed ( )
inlinestatic

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

Returns
StatusMask liveliness_changed

◆ liveliness_lost()

static StatusMask liveliness_lost ( )
inlinestatic

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

Returns
StatusMask liveliness_lost

◆ none()

static StatusMask none ( )
inlinestatic

Get no StatusMasks.

Returns
StatusMask none

◆ offered_deadline_missed()

static StatusMask offered_deadline_missed ( )
inlinestatic

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

Returns
StatusMask offered_deadline_missed

◆ offered_incompatible_qos()

static StatusMask offered_incompatible_qos ( )
inlinestatic

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

Returns
StatusMask offered_incompatible_qos

◆ operator<<()

StatusMask & operator<< ( const StatusMask mask)
inline

Add given StatusMask bits into this StatusMask bitset.

Returns
StatusMask this

◆ operator>>()

StatusMask & operator>> ( const StatusMask mask)
inline

Remove given StatusMask bits into this StatusMask bitset.

Returns
StatusMask this

◆ publication_matched()

static StatusMask publication_matched ( )
inlinestatic

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

Returns
StatusMask publication_matched

◆ requested_deadline_missed()

static StatusMask requested_deadline_missed ( )
inlinestatic

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

Returns
StatusMask requested_deadline_missed

◆ requested_incompatible_qos()

static StatusMask requested_incompatible_qos ( )
inlinestatic

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

Returns
StatusMask requested_incompatible_qos

◆ sample_lost()

static StatusMask sample_lost ( )
inlinestatic

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

Returns
StatusMask sample_lost

◆ sample_rejected()

static StatusMask sample_rejected ( )
inlinestatic

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

Returns
StatusMask sample_rejected

◆ subscription_matched()

static StatusMask subscription_matched ( )
inlinestatic

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

Returns
StatusMask subscription_matched

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