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

This class represents a physical data stream from the device and it is responsible for the buffer handling. This class belongs to the BGAPI2 main classes. More...

#include <bgapi2_genicam.hpp>

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

Public Member Functions

void Open ()
 This function opens the DataStream object and makes their functions available. An exception are the info-functions, which are already available before opening the DataStream object. More...
 
void Close ()
 This function closes the DataStream object and releases the used resources. More...
 
bo_bool IsOpen ()
 This function delivers true, if the data stream is opened. More...
 
BufferListGetBufferList ()
 This function delivers the buffer list of the DataStream object. More...
 
String GetID ()
 This function delivers the unique string identifier of the DataStream object, which is used in the DataStream list. More...
 
String GetTLType ()
 This function delivers the transport layer type of the DataStream object. More...
 
bo_bool GetDefinesPayloadSize ()
 This function delivers true, if the DataStream object supports the function DataStream::GetPayloadSize. More...
 
bo_uint64 GetPayloadSize ()
 This function delivers the size of the expecting data block of this DataStream object in bytes based on the current device settings and including all control data (e.g. chunk header). More...
 
bo_bool GetIsGrabbing ()
 This function delivers true, if the DataStream object is started. See functions DataStream::StartAcquisition and DataStream:StartAcquisitionContinuous. More...
 
void StartAcquisition (bo_uint64 iNumToAcquire)
 This function starts the DataStream object. It is ready to receive data blocks. After receiving the specified number of data blocks the DataStrem object is automatically stopped. More...
 
void StartAcquisitionContinuous ()
 This function starts the DataStream object. It is ready to receive data blocks. The DataStream object is started for an undefined number of transmissions until it is stopped by one of the two functions DataStream::StopAcquisition or DataStream::AbortAcquisition. More...
 
void StopAcquisition ()
 This function stops the DataStream object directly if no transmission is active or after finishing a active transmission. It is not longer possible to receive data blocks. More...
 
void AbortAcquisition ()
 This function stops the DataStream object immediately. Active transmissions are aborted. The aborted buffer gets the status 'incomplete'. See function Buffer::GetIsIncomplete. More...
 
BufferGetBufferByIndex (bo_uint iIndex)
 This function is deprecated. Please use instead the BufferList class. More...
 
DeviceGetParent ()
 This function delivers the superordinate Device object. More...
 
void * GetReserved ()
 Undocumented function.
 
- Public Member Functions inherited from BGAPI2::INode
NodeGetNode (String name)
 This function delivers a certain object of the Node list and provides the access to a node objcet without the detour across a NodeMap object. This function is functional identical to NodeMap::GetNode. More...
 
NodeMapGetNodeTree ()
 This function provides the features of a object derived from INode interface as tree structure in form of a NodeMap pointer. For a detailed description of the tree structure representation refer to the class description of NodeMap. More...
 
NodeMapGetNodeList ()
 This function provides the features of a object derived from INode interface as unstructured list in form of a NodeMap pointer. For a detailed description of the unstructured list representation refer to the class description of NodeMap. More...
 
- Public Member Functions inherited from BGAPI2::Events::DataStreamEventControl
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...
 

Friends

class DataStreamList
 
class BufferList
 
class Buffer
 

Detailed Description

This class represents a physical data stream from the device and it is responsible for the buffer handling. This class belongs to the BGAPI2 main classes.

Definition at line 2513 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ AbortAcquisition()

BGAPI2::DataStream::AbortAcquisition ( )

This function stops the DataStream object immediately. Active transmissions are aborted. The aborted buffer gets the status 'incomplete'. See function Buffer::GetIsIncomplete.

Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

◆ Close()

BGAPI2::DataStream::Close ( )

This function closes the DataStream object and releases the used resources.

Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::LowLevelExceptionGenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information.

◆ GetBufferByIndex()

BGAPI2::DataStream::GetBufferByIndex ( bo_uint  iIndex)

This function is deprecated. Please use instead the BufferList class.

This function delivers a pointer to a specified Buffer object.

Parameters
iIndexThe index of the Buffer object.
Returns
Buffer* The requested pointer to the Buffer object.
Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

◆ GetBufferList()

BGAPI2::DataStream::GetBufferList ( )

This function delivers the buffer list of the DataStream object.

Returns
BufferList* The pointer to the data buffer list of the DataStream object.
Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

◆ GetDefinesPayloadSize()

BGAPI2::DataStream::GetDefinesPayloadSize ( )

This function delivers true, if the DataStream object supports the function DataStream::GetPayloadSize.

Returns
bo_bool If the delivered value is true, the DataStream object supports the function DataStream::GetPayloadSize.
Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

◆ GetID()

BGAPI2::DataStream::GetID ( )

This function delivers the unique string identifier of the DataStream object, which is used in the DataStream list.

Returns
String The unique string identifier.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

◆ GetIsGrabbing()

BGAPI2::DataStream::GetIsGrabbing ( )

This function delivers true, if the DataStream object is started. See functions DataStream::StartAcquisition and DataStream:StartAcquisitionContinuous.

Returns
bo_bool If the delivered value is true, the DataStream object is started.
Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

◆ GetParent()

BGAPI2::DataStream::GetParent ( )

This function delivers the superordinate Device object.

Returns
Device* A pointer to the superordinate Device object.

◆ GetPayloadSize()

BGAPI2::DataStream::GetPayloadSize ( )

This function delivers the size of the expecting data block of this DataStream object in bytes based on the current device settings and including all control data (e.g. chunk header).

This function is mainly used for devices which supports several data streams to allow stream based memory allocation.

Returns
bo_uint64 The size of the expected data block in bytes.
Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

◆ GetTLType()

BGAPI2::DataStream::GetTLType ( )

This function delivers the transport layer type of the DataStream object.

Returns
String The transport layer type of DataStream object.
Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

◆ IsOpen()

BGAPI2::DataStream::IsOpen ( )

This function delivers true, if the data stream is opened.

Returns
delivers true, if the data stream is open.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

◆ Open()

BGAPI2::DataStream::Open ( )

This function opens the DataStream object and makes their functions available. An exception are the info-functions, which are already available before opening the DataStream object.

Exceptions
Exceptions::ResourceInUseExceptionThis exception will be thrown if the DataStream object is already open.
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::LowLevelExceptionGenTL Producer error. Use IException::GetErrorDescription or check trace output for more detailed error information.

◆ StartAcquisition()

BGAPI2::DataStream::StartAcquisition ( bo_uint64  iNumToAcquire)

This function starts the DataStream object. It is ready to receive data blocks. After receiving the specified number of data blocks the DataStrem object is automatically stopped.

A data block includes all data of the used payload type, e.g. for 'ChunkData' a data block includes all chunk blocks, for 'Image' a data block includes only image data.

Parameters
iNumToAcquireThe number of expected data blocks.
Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

◆ StartAcquisitionContinuous()

BGAPI2::DataStream::StartAcquisitionContinuous ( )

This function starts the DataStream object. It is ready to receive data blocks. The DataStream object is started for an undefined number of transmissions until it is stopped by one of the two functions DataStream::StopAcquisition or DataStream::AbortAcquisition.

Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

◆ StopAcquisition()

BGAPI2::DataStream::StopAcquisition ( )

This function stops the DataStream object directly if no transmission is active or after finishing a active transmission. It is not longer possible to receive data blocks.

Exceptions
Exceptions::NotInitializedExceptionThe DataStream 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.

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