#include <GuardCondition.hpp>
Inheritance diagram for GuardCondition< 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 Condition< DELEGATE > | BASE_T |
Public Member Functions | |
| template<typename T__ > | |
| GuardCondition & | operator= (const T__ &rhs) |
| GuardCondition (DELEGATE_T *p) | |
| GuardCondition (const DELEGATE_REF_T &ref) | |
| template<typename H__ > | |
| GuardCondition (const H__ &h) | |
| ~GuardCondition () | |
| template<typename Functor > | |
| void | handler (const Functor &func) |
| void | reset_handler () |
| void | trigger_value (bool value) |
Static Public Member Functions | |
| static GuardCondition | newGuardCondition () |
Detailed Description
template<typename DELEGATE>
class tdds::core::cond::GuardCondition< DELEGATE >
A GuardCondition object is a specific Condition whose trigger_value is completely under the control of the application. When first created the trigger_value is set to FALSE. The purpose of the GuardCondition is to provide the means for the application to manually wake up a WaitSet. This is accomplished by attaching the GuardCondition to the WaitSet and then setting the trigger_value by means of the set trigger_value operation.
Definition at line 38 of file GuardCondition.hpp.
Member Typedef Documentation
Reimplemented from Condition< DELEGATE >.
Definition at line 40 of file GuardCondition.hpp.
| typedef ::dds::core::smart_ptr_traits< DELEGATE >::ref_type DELEGATE_REF_T |
Reimplemented from Condition< DELEGATE >.
Definition at line 40 of file GuardCondition.hpp.
| typedef DELEGATE DELEGATE_T |
Reimplemented from Condition< DELEGATE >.
Definition at line 40 of file GuardCondition.hpp.
| typedef ::dds::core::smart_ptr_traits< DELEGATE >::weak_ref_type DELEGATE_WEAK_REF_T |
Reimplemented from Condition< DELEGATE >.
Definition at line 40 of file GuardCondition.hpp.
Constructor & Destructor Documentation
| GuardCondition | ( | DELEGATE_T * | p | ) | [inline, explicit] |
Definition at line 40 of file GuardCondition.hpp.
| GuardCondition | ( | const DELEGATE_REF_T & | ref | ) | [inline, explicit] |
Definition at line 40 of file GuardCondition.hpp.
| GuardCondition | ( | const H__ & | h | ) | [inline] |
Definition at line 40 of file GuardCondition.hpp.
| ~GuardCondition | ( | ) | [inline] |
Definition at line 44 of file GuardCondition.hpp.
Member Function Documentation
| void handler | ( | const Functor & | func | ) | [inline] |
Definition at line 49 of file GuardCondition.hpp.
| static GuardCondition newGuardCondition | ( | ) | [static] |
| GuardCondition& operator= | ( | const T__ & | rhs | ) | [inline] |
Reimplemented from Condition< DELEGATE >.
Definition at line 40 of file GuardCondition.hpp.
| void reset_handler | ( | ) | [inline] |
Resets the handler for this condition. After the invocation of this method no handler will be registered with this condition.
Definition at line 57 of file GuardCondition.hpp.
| void trigger_value | ( | bool | value | ) | [inline] |
Definition at line 65 of file GuardCondition.hpp.
The documentation for this class was generated from the following file:
- src/hpp/tdds/core/cond/GuardCondition.hpp
