Class astutedds::dcps::EntityStatusCondition

Class astutedds::dcps::EntityStatusCondition

ClassList > astutedds > dcps > EntityStatusCondition

More...

  • #include <dcps.hpp>

Public Functions

Type Name
EntityStatusCondition () = default
StatusMask get_enabled_statuses () noexcept const
StatusMask get_status_changes () noexcept const
void set_enabled_statuses (StatusMask mask) noexcept
void set_status_changes (StatusMask mask) noexcept
bool trigger_value () noexcept const
True iff (enabled_statuses_ & status_changes_) != 0.

Detailed Description

Lightweight status-condition scaffold attached to any Entity kind (Topic / Publisher / Subscriber / DataWriter / DataReader / DomainParticipant). DDS §2.2.2.1.5. Applications call set_enabled_statuses(mask) to select which status bits should contribute to trigger_value(); the condition triggers when (enabled_statuses & current_status_changes) is non-zero.

Public Functions Documentation

function EntityStatusCondition

astutedds::dcps::EntityStatusCondition::EntityStatusCondition () = default

function get_enabled_statuses

inline StatusMask astutedds::dcps::EntityStatusCondition::get_enabled_statuses () noexcept const

function get_status_changes

inline StatusMask astutedds::dcps::EntityStatusCondition::get_status_changes () noexcept const

function set_enabled_statuses

inline void astutedds::dcps::EntityStatusCondition::set_enabled_statuses (
    StatusMask mask
) noexcept

Set the mask of statuses that participate in triggering. DDS §2.2.2.1.5.2. Default is STATUS_MASK_ALL.

function set_status_changes

inline void astutedds::dcps::EntityStatusCondition::set_status_changes (
    StatusMask mask
) noexcept

Snapshot of currently active status bits (set by the owning Entity). DDS §2.2.2.1.1.6.

function trigger_value

True iff (enabled_statuses_ & status_changes_) != 0. 

inline bool astutedds::dcps::EntityStatusCondition::trigger_value () noexcept const

The documentation for this class was generated from the following file include/astutedds/dcps/dcps.hpp