This class is similar to CycleDataLockedReader, except it allows reading from a particular stage of the pipeline. More...

Public Member Functions
	CycleDataLockedStageReader (const PipelineCycler< CycleDataType > &cycler, int stage, Thread *current_thread=Thread::get_current_thread())

	CycleDataLockedStageReader (const CycleDataLockedStageReader< CycleDataType > &copy)

	CycleDataLockedStageReader (CycleDataLockedStageReader< CycleDataType > &&from) noexcept

Thread *	get_current_thread () const
	Returns the Thread pointer of the currently-executing thread, as passed to the constructor of this object. More...

const CycleDataType *	operator -> () const
	This provides an indirect member access to the actual CycleData data. More...

	operator const CycleDataType * () const
	This allows the CycleDataLockedStageReader to be passed to any function that expects a const CycleDataType pointer. More...

void	operator= (const CycleDataLockedStageReader< CycleDataType > &copy)

void	operator= (CycleDataLockedStageReader< CycleDataType > &&from) noexcept

const CycleDataType *	take_pointer ()
	This is intended to be called only from CycleDataStageWriter when it elevates the pointer from read to write status. More...

Detailed Description

This class is similar to CycleDataLockedReader, except it allows reading from a particular stage of the pipeline.

Member Function Documentation

template<class CycleDataType >

Thread * CycleDataLockedStageReader< CycleDataType >::get_current_thread ( ) const

inline

Returns the Thread pointer of the currently-executing thread, as passed to the constructor of this object.

template<class CycleDataType >

const CycleDataType * CycleDataLockedStageReader< CycleDataType >::operator -> ( ) const

inline

This provides an indirect member access to the actual CycleData data.

template<class CycleDataType >

CycleDataLockedStageReader< CycleDataType >::operator const CycleDataType * ( ) const

inline

This allows the CycleDataLockedStageReader to be passed to any function that expects a const CycleDataType pointer.

template<class CycleDataType >

const CycleDataType * CycleDataLockedStageReader< CycleDataType >::take_pointer ( )

inline

This is intended to be called only from CycleDataStageWriter when it elevates the pointer from read to write status.

This function returns the reader's pointer and relinquishes ownership of the pointer, rendering the reader invalid for future reads.

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