RTI Connext Modern C++ API  Version 7.0.0
dds::core::cond::Condition Class Reference

<<reference-type>> Abstract base class of all the conditions More...

#include <dds/core/cond/Condition.hpp>

Inheritance diagram for dds::core::cond::Condition:
dds::core::cond::GuardCondition dds::core::cond::StatusCondition dds::sub::cond::ReadCondition dds::sub::cond::QueryCondition

Public Member Functions

void dispatch ()
 Dispatches the functors that have been registered with the condition. More...
 
bool trigger_value () const
 This operation retrieves the trigger_value of the Condition. More...
 

Detailed Description

<<reference-type>> Abstract base class of all the conditions

Note
Condition and its subclasses provide all the functions of a <<reference-type>> except close() and retain().

This basic class is specialised in three classes:

dds::core::cond::GuardCondition, dds::core::cond::StatusCondition, and dds::sub::cond::ReadCondition.

A dds::core::cond::Condition has a trigger_value that can be true or false and is set automatically by RTI Connext.

See also
dds::core::cond::WaitSet
Waitset Use Cases

Member Function Documentation

◆ dispatch()

void dds::core::cond::Condition::dispatch ( )
inline

Dispatches the functors that have been registered with the condition.

If trigger_value() is true, calling dispatch() will call the registered functor handlers.

Note: it is more common to use WaitSet::dispatch() rather than this function.

◆ trigger_value()

bool dds::core::cond::Condition::trigger_value ( ) const
inline

This operation retrieves the trigger_value of the Condition.