DDS-PSM-C++ 1.0 ISO C++ API for OpenSplice DDS |
#include <TStatusCondition.hpp>
Public Member Functions | |
TStatusCondition (const dds::core::Entity &e) | |
void | enabled_statuses (const ::dds::core::status::StatusMask &status) const |
const ::dds::core::status::StatusMask | enabled_statuses () const |
const dds::core::Entity & | entity () const |
Public Member Functions inherited from dds::core::cond::TCondition< DELEGATE > | |
~TCondition () | |
void | dispatch () |
bool | trigger_value () const |
Public Member Functions inherited from dds::core::Reference< DELEGATE > | |
Reference (dds::core::null_type &) | |
Reference (const Reference &ref) | |
template<typename D > | |
Reference (const Reference< D > &ref) | |
Reference (DELEGATE_T *p) | |
~Reference () | |
const DELEGATE_REF_T & | delegate () const |
DELEGATE_REF_T & | delegate () |
bool | is_nil () const |
operator const DELEGATE_REF_T & () const | |
operator DELEGATE_REF_T () const | |
operator DELEGATE_REF_T & () | |
template<typename R > | |
bool | operator!= (const R &ref) const |
bool | operator!= (const null_type nil) const |
DELEGATE * | operator-> () |
const DELEGATE * | operator-> () const |
template<typename D > | |
Reference & | operator= (const Reference< D > &that) |
template<typename R > | |
Reference & | operator= (const R &rhs) |
Reference & | operator= (const null_type) |
template<typename R > | |
bool | operator== (const R &ref) const |
bool | operator== (const null_type) const |
Additional Inherited Members | |
Protected Attributes inherited from dds::core::Reference< DELEGATE > | |
DELEGATE_REF_T | impl_ |
A StatusCondition object is a specific Condition that is associated with each Entity. The trigger_value of the 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 StatusCondition. The enabled_statuses and its relation to Listener and WaitSet is detailed in Trigger State of the StatusCondition.
Definition at line 42 of file TStatusCondition.hpp.
dds::core::cond::TStatusCondition< DELEGATE >::TStatusCondition | ( | const dds::core::Entity & | e | ) |
Create a StatusCondition
(Section 7.1.2.1.9, StatusCondition Class) associated with the Entity. The condition can then be added to a WaitSet (Section 7.1.2.1.6, WaitSet Class) so that the application can wait for specific status changes that affect the Entity.
void dds::core::cond::TStatusCondition< DELEGATE >::enabled_statuses | ( | const ::dds::core::status::StatusMask & | status | ) | const |
This operation defines the list of communication statuses that are taken into account to determine the trigger_value of the StatusCondition. This operation may change the trigger_value of the StatusCondition. WaitSet objects behavior depend on the changes of the trigger_value of their attached conditions. Therefore, any WaitSet to which the 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.
status | the enabled statuses |
const ::dds::core::status::StatusMask dds::core::cond::TStatusCondition< DELEGATE >::enabled_statuses | ( | ) | const |
This operation retrieves the list of communication statuses that are taken into account to determine the trigger_value of the StatusCondition. This operation returns the statuses that were explicitly set on the last call to set enabled_statuses or, if set enabled_statuses was never called, the default list (see Section 7.1.2.1.9.1).
const dds::core::Entity& dds::core::cond::TStatusCondition< DELEGATE >::entity | ( | ) | const |