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::TCoherentAccess< DELEGATE > Class Template Reference

#include <TCoherentAccess.hpp>

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

Public Member Functions

 TCoherentAccess (const dds::sub::Subscriber &sub)
 
 ~TCoherentAccess ()
 
void end ()
 
- Public Member Functions inherited from dds::core::Value< DELEGATE >
 Value (const ARG &arg)
 
 Value (const ARG1 &arg1, const ARG2 &arg2)
 
 Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3)
 
 Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3, const ARG4 &arg4)
 
 Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3, const ARG4 &arg4, const ARG5 &arg5)
 
 Value (const ARG1 &arg1, const ARG2 &arg2, const ARG3 &arg3, const ARG4 &arg4, const ARG5 &arg5, const ARG6 &arg6)
 
 ~Value ()
 
const DELEGATE & delegate () const
 
DELEGATE & delegate ()
 
 operator const DELEGATE & () const
 
 operator DELEGATE & ()
 
bool operator!= (const Value &other) const
 
const DELEGATE * operator-> () const
 
DELEGATE * operator-> ()
 
Valueoperator= (const Value &other)
 
bool operator== (const Value &other) const
 

Additional Inherited Members

- Protected Member Functions inherited from dds::core::Value< DELEGATE >
 Value ()
 
 Value (const Value &p)
 
- Protected Attributes inherited from dds::core::Value< DELEGATE >
DELEGATE d_
 

Detailed Description

template<typename DELEGATE>
class dds::sub::TCoherentAccess< DELEGATE >

Definition at line 33 of file TCoherentAccess.hpp.

Constructor & Destructor Documentation

template<typename DELEGATE >
dds::sub::TCoherentAccess< DELEGATE >::TCoherentAccess ( const dds::sub::Subscriber sub)
explicit

This operation indicates that the application is about to access the data samples in any of the DataReader objects attached to the Subscriber. The application is required to use this operation only if PRESENTATION QosPolicy of the Subscriber to which the DataReader belongs has the access_scope set to "GROUP." In the aforementioned case, the operation begin_access must be called prior to calling any of the sample-accessing operations, namely: data_readers on the Subscriber and read, take, read_w_condition, take_w_condition on any DataReader. Otherwise the sample-accessing operations will return the error PRECONDITION_NOT_MET. Once the application has finished accessing the data samples it must call end_access. It is not required for the application to call begin_access/end_access if the PRESENTATION QosPolicy has the access_scope set to something other than GROUP. Calling begin_access/end_access in this case is not considered an error and has no effect. The calls to begin_access/end_access may be nested. In that case, the application must call end_access as many times as it called begin_access.

template<typename DELEGATE >
dds::sub::TCoherentAccess< DELEGATE >::~TCoherentAccess ( )

This operation indicates that the application is about to access the data samples in any of the DataReader objects attached to the Subscriber. The application is required to use this operation only if PRESENTATION QosPolicy of the Subscriber to which the DataReader belongs has the access_scope set to GROUP. In the aforementioned case, the operation begin_access must be called prior to calling any of the sample-accessing operations, namely: data_readers on the Subscriber and read, take, read_w_condition, take_w_condition on any DataReader. Otherwise the sample-accessing operations will return the error PRECONDITION_NOT_MET. Once the application has finished accessing the data samples it must call end_access. It is not required for the application to call begin_access/end_access if the PRESENTATION QosPolicy has the access_scope set to something other than GROUP. Calling begin_access/end_access in this case is not considered an error and has no effect. The calls to begin_access/end_access may be nested. In that case, the application must call end_access as many times as it called begin_access.

Member Function Documentation

template<typename DELEGATE >
void dds::sub::TCoherentAccess< DELEGATE >::end ( )

This operation indicates that the application is about to access the data samples in any of the DataReader objects attached to the Subscriber. The application is required to use this operation only if PRESENTATION QosPolicy of the Subscriber to which the DataReader belongs has the access_scope set to GROUP. In the aforementioned case, the operation begin_access must be called prior to calling any of the sample-accessing operations, namely: data_readers on the Subscriber and read, take, read_w_condition, take_w_condition on any DataReader. Otherwise the sample-accessing operations will return the error PRECONDITION_NOT_MET. Once the application has finished accessing the data samples it must call end_access. It is not required for the application to call begin_access/end_access if the PRESENTATION QosPolicy has the access_scope set to something other than ‘GROUP.’ Calling begin_access/end_access in this case is not considered an error and has no effect. The calls to begin_access/end_access may be nested. In that case, the application must call end_access as many times as it called begin_access.


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