#include <StatusCondition.hpp>
Inheritance diagram for StatusCondition< ENTITY, DELEGATE >:
Public Types | |
| typedef DELEGATE | DELEGATE_T |
| typedef ::dds::core::smart_ptr_traits < DELEGATE >::ref_type | DELEGATE_REF_T |
| typedef ::dds::core::smart_ptr_traits < DELEGATE >::weak_ref_type | DELEGATE_WEAK_REF_T |
| typedef tdds::core::cond::Condition < DELEGATE > | BASE_T |
Public Member Functions | |
| template<typename T__ > | |
| StatusCondition & | operator= (const T__ &rhs) |
| StatusCondition (DELEGATE_T *p) | |
| StatusCondition (const DELEGATE_REF_T &ref) | |
| template<typename H__ > | |
| StatusCondition (const H__ &h) | |
| StatusCondition () | |
| void | enabled_statuses (const ::dds::core::status::StatusMask &status) const |
| const ::dds::core::status::StatusMask | enabled_statuses () const |
Detailed Description
template<typename ENTITY, typename DELEGATE>
class dds::core::cond::StatusCondition< ENTITY, DELEGATE >
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 40 of file StatusCondition.hpp.
Member Typedef Documentation
| typedef tdds::core::cond::Condition< DELEGATE > BASE_T |
Reimplemented from Condition< DELEGATE >.
Definition at line 42 of file StatusCondition.hpp.
| typedef ::dds::core::smart_ptr_traits< DELEGATE >::ref_type DELEGATE_REF_T |
Reimplemented from Condition< DELEGATE >.
Definition at line 42 of file StatusCondition.hpp.
| typedef DELEGATE DELEGATE_T |
Reimplemented from Condition< DELEGATE >.
Definition at line 42 of file StatusCondition.hpp.
| typedef ::dds::core::smart_ptr_traits< DELEGATE >::weak_ref_type DELEGATE_WEAK_REF_T |
Reimplemented from Condition< DELEGATE >.
Definition at line 42 of file StatusCondition.hpp.
Constructor & Destructor Documentation
| StatusCondition | ( | DELEGATE_T * | p | ) | [inline, explicit] |
Definition at line 42 of file StatusCondition.hpp.
| StatusCondition | ( | const DELEGATE_REF_T & | ref | ) | [inline, explicit] |
Definition at line 42 of file StatusCondition.hpp.
| StatusCondition | ( | const H__ & | h | ) | [inline] |
Definition at line 42 of file StatusCondition.hpp.
| StatusCondition | ( | ) | [inline] |
Definition at line 42 of file StatusCondition.hpp.
Member Function Documentation
| void enabled_statuses | ( | const ::dds::core::status::StatusMask & | status | ) | const [inline] |
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.
- Parameters:
-
status the enabled statuses
Definition at line 59 of file StatusCondition.hpp.
| const ::dds::core::status::StatusMask enabled_statuses | ( | ) | const [inline] |
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).
Definition at line 71 of file StatusCondition.hpp.
| StatusCondition& operator= | ( | const T__ & | rhs | ) | [inline] |
Reimplemented from Condition< DELEGATE >.
Definition at line 42 of file StatusCondition.hpp.
The documentation for this class was generated from the following file:
- src/hpp/dds/core/cond/StatusCondition.hpp
