class CycleDataLockedReader< CycleDataType >
This template class calls PipelineCycler::read() in the constructor and PipelineCycler::release_read() in the destructor.
In the interim, it provides a transparent read-only access to the CycleData.
Since a lock is held on the data while the instance of this class exists, no other thread may modify any stage of the pipeline during that time. Thus, this class is appropriate to use for cases in which you might want to read and then modify the data. It is possible to pass an instance of CycleDataLockedReader to the CycleDataWriter constructor, which automatically elevates the read lock into a write lock.
It exists as a syntactic convenience to access the data in the CycleData. It also allows the whole system to compile down to nothing if SUPPORT_PIPELINING is not defined.
Definition at line 47 of file cycleDataLockedReader.h.