DDS-PSM-C++  1.0
ISO C++ API for OpenSplice DDS
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
dds::core::cond::TGuardCondition< DELEGATE > Class Template Reference

#include <TGuardCondition.hpp>

Inheritance diagram for dds::core::cond::TGuardCondition< DELEGATE >:
Inheritance graph
[legend]

Public Member Functions

 TGuardCondition ()
 
 ~TGuardCondition ()
 
template<typename Functor >
void handler (const Functor &func)
 
void reset_handler ()
 
void trigger_value (bool value)
 
- 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 >
Referenceoperator= (const Reference< D > &that)
 
template<typename R >
Referenceoperator= (const R &rhs)
 
Referenceoperator= (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_
 

Detailed Description

template<typename DELEGATE>
class dds::core::cond::TGuardCondition< 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 44 of file TGuardCondition.hpp.

Constructor & Destructor Documentation

template<typename DELEGATE >
dds::core::cond::TGuardCondition< DELEGATE >::TGuardCondition ( )
template<typename DELEGATE >
dds::core::cond::TGuardCondition< DELEGATE >::~TGuardCondition ( )

Member Function Documentation

template<typename DELEGATE >
template<typename Functor >
void dds::core::cond::TGuardCondition< DELEGATE >::handler ( const Functor &  func)

Registers a custom handler with this condition.

template<typename DELEGATE >
void dds::core::cond::TGuardCondition< DELEGATE >::reset_handler ( )

Resets the handler for this condition. After the invocation of this method no handler will be registered with this condition.

template<typename DELEGATE >
void dds::core::cond::TGuardCondition< DELEGATE >::trigger_value ( bool  value)

The documentation for this class was generated from the following file: