![]() |
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
|
The class DataStreamEventControl provides the new buffer event which is used for fetching images. More...
#include <bgapi2_genicam.hpp>
Public Member Functions | |
void | RegisterNewBufferEvent (EventMode eventMode) |
This function registers manually a NewBufferEvent at a DataStream object to detect the receiving of new images. More... | |
void | UnregisterNewBufferEvent () |
This function unregisters manually a NewBufferEvent at a DataStream object. More... | |
Buffer * | GetFilledBuffer (bo_uint64 iTimeout) |
This function fetches a new image from the DataStream object and removes it from the output buffer queue. More... | |
void | CancelGetFilledBuffer () |
This function cancels the current waiting operation on the GetFilledBuffer function and not the image acquisition in the camera. More... | |
void | RegisterNewBufferEventHandler (void *callBackOwner, NewBufferEventHandler pFunc) |
Register a callback function which is called any time a new buffer was received. More... | |
![]() | |
EventMode | GetEventMode () |
This function delivers the current event mode setting. The event mode is controlled by the event register functions. See also enumeration Events::EventMode. More... | |
void * | GetBase () |
Undocumented function. More... | |
The class DataStreamEventControl provides the new buffer event which is used for fetching images.
Definition at line 2085 of file bgapi2_genicam.hpp.
BGAPI2::Events::DataStreamEventControl::CancelGetFilledBuffer | ( | ) |
This function cancels the current waiting operation on the GetFilledBuffer function and not the image acquisition in the camera.
No image acquisition is aborted and an the data transfer will be finished. It is usefull to reduce stop/close operations for process and task.
Exceptions::NotInitializedException | The BGAPI object is not open. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Events::DataStreamEventControl::GetFilledBuffer | ( | bo_uint64 | iTimeout | ) |
This function fetches a new image from the DataStream object and removes it from the output buffer queue.
If the output buffer queue is empty after the timeout, the function delivers NULL.
iTimeout | After this time, the function delivers latest. |
Exceptions::NotInitializedException | The BGAPI object is not open. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
Exceptions::LowLevelException | GenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information. |
Exceptions::AbortException | The waiting operation of this function was canceled. See function CancelGetFilledBuffer. |
BGAPI2::Events::DataStreamEventControl::RegisterNewBufferEvent | ( | EventMode | eventMode | ) |
This function registers manually a NewBufferEvent at a DataStream object to detect the receiving of new images.
This function is currently not implemented. The NewBuffer event is already registered internally, when opening the DataStream object.
eventMode | The event mode specifies the way how to fetch an incoming event. |
Exceptions::NotImplementedException | This function is currently not implemented. |
Exceptions::NotInitializedException | The object is not initialized properly. |
BGAPI2::Events::DataStreamEventControl::RegisterNewBufferEventHandler | ( | void * | callBackOwner, |
NewBufferEventHandler | pFunc | ||
) |
Register a callback function which is called any time a new buffer was received.
callBackOwner | Any object, stays at it is. |
pFunc | Callback event handler. |
Exceptions::NotInitializedException | The BGAPI object is not open. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Events::DataStreamEventControl::UnregisterNewBufferEvent | ( | ) |
This function unregisters manually a NewBufferEvent at a DataStream object.
The NewBuffer event is already unregistered internally, when closing the DataStream object. This function is currently not implemented. If NewBufferEventHandler was registered, Thread will be shutdown, handler removed and all buffers discarded.
Exceptions::NotImplementedException | This function is currently not implemented. |
Exceptions::NotInitializedException | The object is not initialized properly. |
Jan, 14 2020
Baumer Optronic GmbH,
Badstrasse 30, 01454 D-Radeberg, Tel:+49-3528-4386-0, Fax:+49-3528-4386-86,
Email:support.cameras@baumer.com