Namespace: Rx::LFR – Class: CImageQueue – Header: Rx.LFR/ImageQueue.h
CImageQueue Class
#include "Rx.LFR/ImageQueue.h"
class CImageQueue : public CPimpl<CImageQueue_Impl, EImageQueueInterface>A bounded queue that uses the move semantics and that is thread safe.
Template Parameters
| TValue |
The value type. This type requires a move constructor and a move assignment operator. |
Constructors
| CImageQueue() | Default constructor. |
| CImageQueue(xImageQueue) | Move constructor. |
Destructor
| ~CImageQueue() | Destructor. |
Methods
| Initialize(nMaxQueueSize, bOverwriteEnabled) | Sets the maximum queue size and clears the queue. |
| Clear() | Clears this object to its blank/initial state. |
| MoveIn(xImage) | Moves the given image at the end of the queue. This signals the not-empty-event. |
| MoveOut(xImage) | Moves the first image out of the queue. This resets the not-empty-event if the queue is now empty. |
| IsEmpty() | Query if this queue is empty. |
| GetSize() | Gets the current queue size. |
| GetFreeSize() | Gets the free size. This is the maximum queue size minus the current queue size. |
| GetMaxQueueSize() | Gets the maximum queue size. |
| GetOverwriteEnabled() | Gets the overwrite enabled flag. |
| WaitForNotEmpty(iMilliseconds) | Waits until the Queue is not empty, or until the given timeout has passed. |
| GetNotEmptyEventWin32Handle() | Gets the windows handle of the not empty event. This can be used in functions like WaitForSingleObject. |
| GetImpl() | Gets the non constant implementation. (Inherited from CPimpl) |
| GetImpl() | Gets the constant implementation. (Inherited from CPimpl) |
| GetInterface(eInterface) | Gets the interface defined by the given interface ID. (Inherited from CPimpl) |
| GetInterface(eInterface) | Gets the interface defined by the given interface ID. (Inherited from CPimpl) |
| GetInterface(eInterface) | Gets the interface defined by the given interface ID. (Inherited from CPimpl) |
| GetInterface(eInterface) | Gets the interface defined by the given interface ID. (Inherited from CPimpl) |
| HasInterface(eInterface) | Queries if this object has the given interface. (Inherited from CPimpl) |
Operators
| operator=(xImageQueue) | Move assignment operator. |