![]() |
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
|
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>
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... | |
BufferList * | GetBufferList () |
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... | |
Buffer * | GetBufferByIndex (bo_uint iIndex) |
This function is deprecated. Please use instead the BufferList class. More... | |
Device * | GetParent () |
This function delivers the superordinate Device object. More... | |
void * | GetReserved () |
Undocumented function. | |
![]() | |
Node * | GetNode (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... | |
NodeMap * | GetNodeTree () |
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... | |
NodeMap * | GetNodeList () |
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... | |
![]() | |
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... | |
Friends | |
class | DataStreamList |
class | BufferList |
class | Buffer |
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.
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::NotInitializedException | The DataStream 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. |
BGAPI2::DataStream::Close | ( | ) |
This function closes the DataStream object and releases the used resources.
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. |
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.
iIndex | The index of the Buffer object. |
Exceptions::NotInitializedException | The DataStream 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. |
BGAPI2::DataStream::GetBufferList | ( | ) |
This function delivers the buffer list of the DataStream object.
Exceptions::NotInitializedException | The DataStream 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. |
BGAPI2::DataStream::GetDefinesPayloadSize | ( | ) |
This function delivers true, if the DataStream object supports the function DataStream::GetPayloadSize.
Exceptions::NotInitializedException | The DataStream 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. |
BGAPI2::DataStream::GetID | ( | ) |
This function delivers the unique string identifier of the DataStream object, which is used in the DataStream list.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::DataStream::GetIsGrabbing | ( | ) |
This function delivers true, if the DataStream object is started. See functions DataStream::StartAcquisition and DataStream:StartAcquisitionContinuous.
Exceptions::NotInitializedException | The DataStream 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. |
BGAPI2::DataStream::GetParent | ( | ) |
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.
Exceptions::NotInitializedException | The DataStream 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. |
BGAPI2::DataStream::GetTLType | ( | ) |
This function delivers the transport layer type of the DataStream object.
Exceptions::NotInitializedException | The DataStream 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. |
BGAPI2::DataStream::IsOpen | ( | ) |
This function delivers true, if the data stream is opened.
Exceptions::ObjectInvalidException | The calling object is not valid. |
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::ResourceInUseException | This exception will be thrown if the DataStream object is already 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. |
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.
iNumToAcquire | The number of expected data blocks. |
Exceptions::NotInitializedException | The DataStream 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. |
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::NotInitializedException | The DataStream 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. |
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::NotInitializedException | The DataStream 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. |
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