Logo
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
Public Member Functions | List of all members
BGAPI2::Events::DataStreamEventControl Class Reference

The class DataStreamEventControl provides the new buffer event which is used for fetching images. More...

#include <bgapi2_genicam.hpp>

Inheritance diagram for BGAPI2::Events::DataStreamEventControl:
BGAPI2::Events::EventControl BGAPI2::DataStream

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...
 
BufferGetFilledBuffer (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...
 
- Public Member Functions inherited from BGAPI2::Events::EventControl
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...
 

Detailed Description

The class DataStreamEventControl provides the new buffer event which is used for fetching images.

Definition at line 2085 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ CancelGetFilledBuffer()

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
Exceptions::NotInitializedExceptionThe BGAPI object is not open.
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

◆ GetFilledBuffer()

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.

Parameters
iTimeoutAfter this time, the function delivers latest.
Returns
Buffer* The buffer object which includes the new image or NULL in case of timeout.
Exceptions
Exceptions::NotInitializedExceptionThe BGAPI object is not open.
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::LowLevelExceptionGenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information.
Exceptions::AbortExceptionThe waiting operation of this function was canceled. See function CancelGetFilledBuffer.

◆ RegisterNewBufferEvent()

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.

Parameters
eventModeThe event mode specifies the way how to fetch an incoming event.
Exceptions
Exceptions::NotImplementedExceptionThis function is currently not implemented.
Exceptions::NotInitializedExceptionThe object is not initialized properly.

◆ RegisterNewBufferEventHandler()

BGAPI2::Events::DataStreamEventControl::RegisterNewBufferEventHandler ( void *  callBackOwner,
NewBufferEventHandler  pFunc 
)

Register a callback function which is called any time a new buffer was received.

Parameters
callBackOwnerAny object, stays at it is.
pFuncCallback event handler.
Returns
void
Exceptions
Exceptions::NotInitializedExceptionThe BGAPI object is not open.
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

◆ UnregisterNewBufferEvent()

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
Exceptions::NotImplementedExceptionThis function is currently not implemented.
Exceptions::NotInitializedExceptionThe object is not initialized properly.

The documentation for this class was generated from the following file:
bgapi: BGAPI::Camera Class Reference

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