RTI Connext Modern C++ API
Version 5.2.3
|
<<reference-type>> A condition associated with each dds::core::Entity More...
#include <dds/core/cond/StatusCondition.hpp>
Public Member Functions | |
StatusCondition (const dds::core::Entity &entity) | |
Obtains a reference to the StatusCondition in an entity. | |
void | enabled_statuses (const dds::core::status::StatusMask &status) |
Defines the list of communication statuses that determine the trigger value. | |
const dds::core::status::StatusMask | enabled_statuses () const |
Gets the list of enabled statuses. | |
dds::core::Entity | entity () const |
Get the dds::core::Entity associated with this StatusCondition. | |
template<typename Functor > | |
void | handler (const Functor &func) |
<<extension>> Registers a custom handler with this condition. | |
void | reset_handler () |
<<extension>> Resets the handler for this condition. | |
![]() | |
void | dispatch () |
Dispatches the functors that have been registered with the condition. | |
bool | trigger_value () const |
This operation retrieves the trigger_value of the Condition. | |
<<reference-type>> A condition associated with each dds::core::Entity
The trigger_value
of the dds::core::cond::StatusCondition depends on the communication status of that entity (e.g., arrival of data, loss of information, etc.), 'filtered' by the set of enabled_statuses
on the dds::core::cond::StatusCondition.
.
|
inline |
Obtains a reference to the StatusCondition in an entity.
entity | The Entity whose status condition we're getting a reference to. There is exactly one StatusCondition per Entity and one Entity per StatusCondition. |
|
inline |
Defines the list of communication statuses that determine the trigger value.
This operation may change the trigger_value
of the dds::core::cond::StatusCondition.
dds::core::cond::WaitSet objects' behavior depends on the changes of the trigger_value
of their attached conditions. Therefore, any dds::core::cond::WaitSet to which the dds::core::cond::StatusCondition is attached is potentially affected by this operation.
If this function is not invoked, the default list of enabled statuses includes all the statuses.
One | of the Standard Exceptions |
|
inline |
Gets the list of enabled statuses.
|
inline |
Get the dds::core::Entity associated with this StatusCondition.
There is exactly one Entity associated with each StatusCondition.
void handler | ( | const Functor & | func | ) |
<<extension>> Registers a custom handler with this condition.
For information about condition handlers, see this ReadCondition constructor
void reset_handler | ( | ) |
<<extension>> Resets the handler for this condition.
After the invocation of this method no handler will be registered with this condition.