#include <CoherentAccess.hpp>
Inheritance diagram for CoherentAccess< DELEGATE >:
Public Member Functions | |
| CoherentAccess (const dds::sub::Subscriber &sub) | |
| void | end () |
| ~CoherentAccess () | |
Detailed Description
template<typename DELEGATE>
class tdds::sub::CoherentAccess< DELEGATE >
Definition at line 29 of file CoherentAccess.hpp.
Constructor & Destructor Documentation
| CoherentAccess | ( | 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.
| ~CoherentAccess | ( | ) |
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
| void 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:
- src/hpp/tdds/sub/CoherentAccess.hpp
