Inherits NativeWrapper< Rx::LFR::CImageQueue >.
◆ ImageQueue() [1/2]
Rx::LFR::Net::ImageQueue::ImageQueue |
( |
| ) |
|
|
inline |
◆ ImageQueue() [2/2]
Constructor.
Wraps the given native instance instead of creating an own instance. The given native instance must be valid for the lifetime of this instance.
- Parameters
-
xNative | [in] The native instance to be wrapped by this class. |
◆ ~ImageQueue()
Rx::LFR::Net::ImageQueue::~ImageQueue |
( |
| ) |
|
|
inline |
◆ Clear()
void Rx::LFR::Net::ImageQueue::Clear |
( |
| ) |
|
|
inline |
Clears this object to its blank/initial state.
◆ CopyIn()
Copies an image into the image queue.
- Parameters
-
- Returns
- True if it succeeds, false if it fails.
◆ GetFreeSize()
size_t Rx::LFR::Net::ImageQueue::GetFreeSize |
( |
| ) |
|
|
inline |
Gets the free size. This is the maximum queue size minus the current queue size.
- Returns
- The free size.
◆ GetMaxQueueSize()
size_t Rx::LFR::Net::ImageQueue::GetMaxQueueSize |
( |
| ) |
|
|
inline |
Gets the maximum queue size.
- Returns
- The maximum queue size.
◆ GetOverwriteEnabled()
bool Rx::LFR::Net::ImageQueue::GetOverwriteEnabled |
( |
| ) |
|
|
inline |
Gets the overwrite enabled flag.
- Returns
- The overwrite enabled flag.
◆ GetSize()
size_t Rx::LFR::Net::ImageQueue::GetSize |
( |
| ) |
|
|
inline |
Gets the current queue size.
- Returns
- The current queue size.
◆ GetWaitEvent()
System::Threading::ManualResetEvent ^ Rx::LFR::Net::ImageQueue::GetWaitEvent |
( |
| ) |
|
|
inline |
Gets the wait event.
- Returns
- Null if it fails, else the wait event.
◆ Initialize()
void Rx::LFR::Net::ImageQueue::Initialize |
( |
size_t |
nMaxQueueSize, |
|
|
bool |
bOverwriteEnabled |
|
) |
| |
|
inline |
Sets the maximum queue size and clears the queue.
- Parameters
-
nMaxQueueSize | [in] The maximum queue size. |
bOverwriteEnabled | [in] True to enable overwriting of the oldest queue element if the queue is full on MoveIn. |
◆ IsEmpty()
bool Rx::LFR::Net::ImageQueue::IsEmpty |
( |
| ) |
|
|
inline |
Query if this queue is empty.
- Returns
- True if empty, false if not.
◆ MoveIn()
Moves the given image at the end of the queue. This signals the not-empty-event which would end the waiting at the WaitForNotEmpty function.
- Parameters
-
xImage | [in,out] The image to move into the queue. May be invalid after this call. |
- Returns
- True if it succeeds, false if the queue is full and overwrite is disabled.
◆ MoveOut()
Moves the first image out of the queue. This resets the not-empty-event if the queue is now empty which would cause the waiting using the WaitForNotEmpty function.
- Parameters
-
xImage | [out] The first image of the queue. |
- Returns
- True if it succeeds, false if the queue is empty.
◆ WaitForNotEmpty() [1/2]
bool Rx::LFR::Net::ImageQueue::WaitForNotEmpty |
( |
| ) |
|
|
inline |
Waits for the not empty event.
- Returns
- True if it succeeds, false if it fails.
◆ WaitForNotEmpty() [2/2]
bool Rx::LFR::Net::ImageQueue::WaitForNotEmpty |
( |
int |
iMilliseconds | ) |
|
|
inline |
Waits for the not empty event.
- Parameters
-
iMilliseconds | [in] The maximum number of milliseconds to wait, before returning false. |
- Returns
- True if it succeeds, false if a timeout occured.