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::sub::cond::TReadCondition< DELEGATE > Class Template Reference

#include <TReadCondition.hpp>

Inheritance diagram for dds::sub::cond::TReadCondition< DELEGATE >:
Inheritance graph
[legend]

Public Member Functions

template<typename T >
 TReadCondition (const dds::sub::DataReader< T > &dr, const dds::sub::status::DataState &status)
 
template<typename T , typename FUN >
 TReadCondition (const dds::sub::DataReader< T > &dr, const dds::sub::status::DataState &status, const FUN &functor)
 
 ~TReadCondition ()
 
const AnyDataReaderdata_reader () const
 
const dds::sub::status::DataState state_filter () 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 >
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::sub::cond::TReadCondition< DELEGATE >

ReadCondition objects are conditions specifically dedicated to read operations and attached to one DataReader.
ReadCondition objects allow an application to specify the data samples it is interested in (by specifying the desired sample states, view states, and instance states). See the parameter definitions for DataReader's read/take operations.) This allows the middleware to enable the condition only when suitable information is available. They are to be used in conjunction with a WaitSet as normal conditions. More than one ReadCondition may be attached to the same DataReader.

Definition at line 43 of file TReadCondition.hpp.

Constructor & Destructor Documentation

template<typename DELEGATE >
template<typename T >
dds::sub::cond::TReadCondition< DELEGATE >::TReadCondition ( const dds::sub::DataReader< T > &  dr,
const dds::sub::status::DataState &  status 
)
template<typename DELEGATE >
template<typename T , typename FUN >
dds::sub::cond::TReadCondition< DELEGATE >::TReadCondition ( const dds::sub::DataReader< T > &  dr,
const dds::sub::status::DataState &  status,
const FUN &  functor 
)
template<typename DELEGATE >
dds::sub::cond::TReadCondition< DELEGATE >::~TReadCondition ( )

Member Function Documentation

template<typename DELEGATE >
const AnyDataReader& dds::sub::cond::TReadCondition< DELEGATE >::data_reader ( ) const
template<typename DELEGATE >
const dds::sub::status::DataState dds::sub::cond::TReadCondition< DELEGATE >::state_filter ( ) const

This operation returns the set of sample-states that are taken into account to determine the trigger_value of the ReadCondition. These are the sample-states specified when the ReadCondition was created.


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