0% found this document useful (0 votes)
210 views

Baumer Gapi 2 Release Notes: 1/15 Baumer Optronic GMBH Radeberg, Germany

This document contains release notes for multiple versions of the Baumer GAPI software package. It outlines new features and fixes for versions 2.4, 2.3 SP5, 2.3 SP4, 2.3 SP3, 2.3 SP2, and 2.3 SP1 of the BGAPI across components like the consumer, GigE interface, USB interface, image processor, examples, documentation, and tools. Sections for each release note describe changes made in the corresponding BGAPI version.

Uploaded by

Nagarajan
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
0% found this document useful (0 votes)
210 views

Baumer Gapi 2 Release Notes: 1/15 Baumer Optronic GMBH Radeberg, Germany

This document contains release notes for multiple versions of the Baumer GAPI software package. It outlines new features and fixes for versions 2.4, 2.3 SP5, 2.3 SP4, 2.3 SP3, 2.3 SP2, and 2.3 SP1 of the BGAPI across components like the consumer, GigE interface, USB interface, image processor, examples, documentation, and tools. Sections for each release note describe changes made in the corresponding BGAPI version.

Uploaded by

Nagarajan
Copyright
© © All Rights Reserved
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 15

Baumer GAPI 2 Release Notes

Inhalt
1 Release Notes BGAPI 2.4 .................................................................................................................................................. 3
1.1 BGAPI....................................................................................................................................................................................................................... 3
1.1.1 Consumer ............................................................................................................................................................................................................... 3
1.1.2 GigE Interface ....................................................................................................................................................................................................... 4
1.1.3 Image processor .................................................................................................................................................................................................. 4
1.2 Examples ................................................................................................................................................................................................................ 4
1.3 Doc............................................................................................................................................................................................................................. 5
1.4 Tools ......................................................................................................................................................................................................................... 5

2 Release Notes BGAPI 2.3 SP5.......................................................................................................................................... 5


2.1 BGAPI....................................................................................................................................................................................................................... 5
2.1.1 Consumer ............................................................................................................................................................................................................... 5
2.1.2 GigE Interface ....................................................................................................................................................................................................... 5
2.1.3 USB Interface ........................................................................................................................................................................................................ 6
2.1.4 Image processor .................................................................................................................................................................................................. 6
2.2 Examples ................................................................................................................................................................................................................ 6
2.3 Doc............................................................................................................................................................................................................................. 6
2.4 Tools ......................................................................................................................................................................................................................... 6

3 Release Notes BGAPI 2.3 SP4.......................................................................................................................................... 6


3.1 BGAPI....................................................................................................................................................................................................................... 6
3.1.1 Consumer ............................................................................................................................................................................................................... 7
3.1.2 GigE Interface ....................................................................................................................................................................................................... 7
3.1.3 USB Interface ........................................................................................................................................................................................................ 7
3.1.4 Image processor .................................................................................................................................................................................................. 7
3.2 Examples ................................................................................................................................................................................................................ 7
3.3 Doc............................................................................................................................................................................................................................. 7
3.4 Tools ......................................................................................................................................................................................................................... 7

4 Release Notes BGAPI 2.3 SP 3......................................................................................................................................... 8


4.1 BGAPI....................................................................................................................................................................................................................... 8
4.1.1 Consumer ............................................................................................................................................................................................................... 8
4.1.2 GigE Interface ....................................................................................................................................................................................................... 8
4.1.3 USB Interface ........................................................................................................................................................................................................ 8
4.1.4 Image processor .................................................................................................................................................................................................. 8
4.2 Examples ................................................................................................................................................................................................................ 8
4.3 Doc............................................................................................................................................................................................................................. 8
4.4 Tools ......................................................................................................................................................................................................................... 8

5 Release Notes BGAPI 2.3 SP 2......................................................................................................................................... 8


5.1 BGAPI....................................................................................................................................................................................................................... 8
5.1.1 Consumer ............................................................................................................................................................................................................... 8
5.1.2 GigE Interface ....................................................................................................................................................................................................... 9
5.1.3 USB Interface ........................................................................................................................................................................................................ 9
5.1.4 Image processor .................................................................................................................................................................................................. 9
5.2 Examples ................................................................................................................................................................................................................ 9
5.3 Doc............................................................................................................................................................................................................................. 9
5.4 Tools ......................................................................................................................................................................................................................... 9

1/15 Baumer Optronic GmbH


6 Release Notes BGAPI 2.3 SP 1......................................................................................................................................... 9
6.1 BGAPI....................................................................................................................................................................................................................... 9
6.1.1 Consumer ............................................................................................................................................................................................................... 9
6.1.2 GigE Interface .................................................................................................................................................................................................... 10
6.1.3 USB Interface ..................................................................................................................................................................................................... 10
6.1.4 Image processor ............................................................................................................................................................................................... 10
6.2 Examples ............................................................................................................................................................................................................. 10
6.3 Doc.......................................................................................................................................................................................................................... 10
6.4 Tools ...................................................................................................................................................................................................................... 10

7 Release Notes BGAPI 2.3 ................................................................................................................................................10


7.1 BGAPI.................................................................................................................................................................................................................... 11
7.1.1 Consumer ............................................................................................................................................................................................................ 11
7.1.2 GigE Interface .................................................................................................................................................................................................... 11
7.1.3 USB Interface ..................................................................................................................................................................................................... 11
7.1.4 Image processor ............................................................................................................................................................................................... 12
7.2 Examples ............................................................................................................................................................................................................. 12
7.3 Doc.......................................................................................................................................................................................................................... 12
7.4 Tools ...................................................................................................................................................................................................................... 12
7.4.1 CameraExplorer ................................................................................................................................................................................................ 12

8 Release Notes BGAPI 2.2 SP 1.......................................................................................................................................13


8.1 BGAPI.................................................................................................................................................................................................................... 13
8.1.1 Consumer ............................................................................................................................................................................................................ 13
8.1.2 GigE Interface .................................................................................................................................................................................................... 13
8.1.3 USB Interface ..................................................................................................................................................................................................... 13
8.1.4 Image processor ............................................................................................................................................................................................... 13
8.2 Examples ............................................................................................................................................................................................................. 13
8.3 Doc.......................................................................................................................................................................................................................... 13
8.4 Tools ...................................................................................................................................................................................................................... 13

9 Release Notes BGAPI 2.2 ................................................................................................................................................13


9.1 BGAPI.................................................................................................................................................................................................................... 13
9.1.1 Consumer ............................................................................................................................................................................................................ 14
9.1.2 GigE Interface .................................................................................................................................................................................................... 15
9.1.3 USB Interface ..................................................................................................................................................................................................... 15
9.1.4 Image processor ............................................................................................................................................................................................... 15
9.2 Examples ............................................................................................................................................................................................................. 15
9.3 Doc.......................................................................................................................................................................................................................... 15
9.4 Tools ...................................................................................................................................................................................................................... 15

2/15 Baumer Optronic GmbH


1 Release Notes BGAPI 2.4
1.1 BGAPI
 Information
o All Linux distributions were up to date at the time of creation version 2.4.
 Added Linux distributions Debian 7.9, Debian 8.2, Fedora 22
 Removed Linux distributions Debian 7.8, Debian 8.0, Fedora 20
o Support for ARM platforms added

1.1.1 Consumer
 Enhancements
o Support Windows 10 for USB3 Vision
o Support Windows 10 for GigE Vision – NDIS 6 based Filter driver for Windows 10 added
o API behavior changes
 GenICam nodes of type ‘String’ are now supported by functions INode::GetNodeList
and INode::GetNodeTree
 Implemented the mechanism behind the mandatory SFNC feature TLParamsLocked.
For backward compatibility with existing BGAPI implementations the Consumer
provides the Device feature DisableTLParamsLocked which bypasses this mechanism.
 Confusing behavior of function SystemList::Refresh clarified. The function throws an
exception, if the initialization of at least one GenTL producer fails but the list was
filled with valid producer objects. The new version solved this behavior in the
following way: The Refresh function doesn’t throw an exception when it enumerates
an invalid GenTL producer. This producer will now add to the system list. The
exception is thrown when the user accessing it directly.
 Caching type changed from WriteAround to WriteThrough for all node types except
nodes with IFloat interface (see function Node::GetInterface to determine the node
type and table API changes).
 Behavior of C++ function Node::GetDoubleInc and C# property Node.Inc changed to
be standard conform. The function throws an exception, if the underlying GenICam
XML description file doesn’t contain the <Inc> element. To avoid the exception use
C++ function Node::HasInc (property Node.HasInc for C# respectively).

o API changes

Description C++ Changed C# Changed


functions/definitions functions/definitions
New parameter added to Device::StartStacking( Device.StartStacking(
the function StartStacking bo_bool bReplaceMode) bool bReplaceMode)
to control whether all
accesses to a register will
be transferred to the
device or only the last one.
Clarify behavior of EVENTMODE_DISABLE EventMode.DISABLE
EVENTMODE_DISABLE and renamed to renamed to
renamed it to EVENTMODE_UNREGISTERED EventMode.UNREGISTERED
EVENTMODE_UNREGISTERED
Renamed RGB planar pixel "RGB8Planar" renamed to "RGB8Planar" renamed to
formats to be PFNC "RGB8_Planar" "RGB8_Planar"
compliant. "RGB10Planar" renamed to "RGB10Planar" renamed to
"RGB10_Planar" "RGB10_Planar"

3/15 Baumer Optronic GmbH


"RGB12Planar" renamed to "RGB12Planar" renamed to
"RGB12_Planar" "RGB12_Planar"
"RGB16Planar" renamed to "RGB16Planar" renamed to
"RGB16_Planar" "RGB16_Planar"
C# Added functions
Find functions added – SystemList.find
useful for faster access InterfaceList.find
DeviceList.find
DataStreamList.find
BufferList.find
C++ Removed functions C# Removed functions
Useless functions removed. SystemList::erase SystemList.Remove
InterfaceList::erase
DeviceList::erase
DataStreamList::erase
BufferList::erase

o C# Interface
 Solved a problem with removing initialized objects (refer to clear() functions of
BGAPI2 list classes)

 Bugfixes
o A Buffer with faulty chunk data doesn’t deliver a ChunkNodeMap. But the buffer remains in
this error state even if the chunk data is correct within the next image.
o Solved a problem which blocks the image callback, e.g. caused by a corrupted chunk block
o Solved a problem under Linux platform when loading a GenTL producer from the GenICam
path.
o C++ Interface
 Solved a problem with assignment operator.
o C# Interface
 Solved a problem, which signals DeviceEvents multiple times, when reopen a device.
 Access to RemoteNodeList after Device.Close throws now a
BGAPI2.Exceptions.NotInitializedException instead of
System.AccessViolationException.
 Solve a problem when calling DataStream::RegisterNewBufferEvent with
EventMode.POLLING and EventMode.UNREGISTERED

1.1.2 GigE Interface


 Bugfixes
o Solved a problem with deactivating the filter driver for a selected network adapter.

1.1.3 Image processor


 Bugfixes
o Transform image into RGB8_Planar when using the default Demosaicing method Bilinear 3x3
is now possible. Renamed RGB planar pixel formats to be PFNC compliant (see table API
changes)

1.2 Examples
 Enhancements

4/15 Baumer Optronic GmbH


o renamed the EventMode DISABLE (see Consumer) in the following examples:
006_DeviceEventMode_Polling, 010_PnPEventMode_Polling, 011_ImageCaptureMode_Handler,
012_DeviceEventMode_Handler, 012_DeviceEventMode_Handler

1.3 Doc
 InstallationGuide_Linux.pdf
 ProgrammersGuide.pdf

1.4 Tools
 CameraExplorer
o Enhancements
 Supports loading and saving user sets for LXG cameras series
 Improved displaying of images in Baumer Raw Format (.brw)
 Supports the image format JPEG2000 for saving images to file
 Setup
o Enhancements
 Reorganized Startup Menu. Changed to flat style with the new folder name Baumer
GAPI-SDK.

2 Release Notes BGAPI 2.3 SP5

2.1 BGAPI
 Information
o All Linux distributions were up to date at the time of creation SP5.

2.1.1 Consumer
 Enhancements
o C# interface
 Documentation file bgapi2_genicam_dotnet.XML added
 Additional Buffer constructor added, which allows the programmer to use his own
memory
 Problem solved, function CreateBitmap produces only gray images if the source
image has RGB pixel format
 Bugfixes
o Crash fixed: BufferList deletes user allocated Buffer objects
o Crash with multi-thread application fixed
o Device::Close closes the corresponding data stream object

2.1.2 GigE Interface


 Enhancements
o Deactivation of GEV Control Channel lock is now possible if device connection is lost (see
feature UseControlChannelLocking)
 Bugfixes
o Resend algorithm improved: The Resend algorithm signals a buffer under specific conditions
as incomplete. This behavior occurs only, if the previous signaled buffer was also incomplete.
o GigE Producer under WindowsXP now, find new cameras series, like LXG
o Improved handling with long heartbeat timeouts.

5/15 Baumer Optronic GmbH


o Buffer states improved
o Action command returned with unjustified timeout.

2.1.3 USB Interface


 Bugfixes
o Buffer states improved
o PnP behavior adjusted: programmer has to call Device::Close after a remove event

2.1.4 Image processor


 Enhancements
o Supports image transformation in RGB Planar formats higher than 8 bits
 Bugfixes
o The DemosaicingMethod Bilinear3x3 doesn’t reach the maximum gray scale value

2.2 Examples
 Enhancements
o Supports creating project files for Visual Studio 2013 (see new cmake installer)
o Example 005_PixelTransformation extended: now it shows the using of several demosaicing
methods (see image processor feature ‘DemosaicingMethod’).

2.3 Doc
 InstallationGuide_Linux.pdf
o Document folder corrected (see chapter 4.2.3)
 ProgrammersGuide.pdf
o Hint to C# documentation file bgapi2_genicam_dotnet.xml added (see chapter 4.4.3.1)
o Description added: How to use user allocated buffer (see chapter 5.1.10)

2.4 Tools
 IPConfigTool
o Enhancements
 Speed up setting persistent IP in multi camera systems

 CameraExplorer
o Bugfixes
 RGB value in status bar was not refreshed in live view
 Correct displaying GigE interfaces when using Asian OS languages
 Correct refreshing the received buffer counter in the info view.
 Shortcuts doesn’t work after switching to full screen mode and back

3 Release Notes BGAPI 2.3 SP4

3.1 BGAPI
 Information
o All Linux distributions were up to date at the time of creation SP4.
o Linux distribution Debian version 8.0 added
o Linux distribution Fedora 21 added

6/15 Baumer Optronic GmbH


o Linux distribution Debian version 7.7 changed to Debian version 7.8

3.1.1 Consumer
 Enhancements
o Stacked write now available in C# interface.
o Stacked mode allows writing the same feature more than once.
o All SFNC 1.5 feature names available in bgapi2_featurenames.h.
 Bugfixes
o GetImagePresent returns false instead of an exception, if image chunk is not present.
o GetFilledBuffer lost images under certain error situation (faulty chunk format caused by
transmission).
o CreateInstanceFromPath function works now under Linux.

3.1.2 GigE Interface


 Enhancements
o The limit of interfaces (about 10 NIC’s) was repealed regarding MTU detection.
 Bugfixes
o Deadlock solved, when closing an interface under Linux.

3.1.3 USB Interface


 Enhancements
o Added standalone installer for USB driver (msi file) for Windows.
 Bugfixes
o Crash fixed, if camera sends an invalid size of USB descriptor.
o Crash fixed, if camera sends corrupted chunk data.
o Reopen device doesn’t work if system close was called without calling device close before.
o Bugfix Pending Acknowledge.

3.1.4 Image processor


 Enhancements
o Revised color fidelity -> New demosaicing algorithms added. New feature added to switch
between these algorithms: DemosaicingMethod.
o New features added to the node interface which allows the modification of active color matrix:
ColorTransformationValueSelector and ColorTransformationValue
o See the documentation ProgrammersGuide_BaumerFeatures.pdf.

3.2 Examples
 No functional changes

3.3 Doc
 No Changes

3.4 Tools
 IPConfigTool
o Enhancements
 IPConfigTool now available for Linux (without Force IP).
o Bugfixes
 Invalid input of IP address leads to inadvertent programming.
 CameraExplorer
o Bugfixes

7/15 Baumer Optronic GmbH


 Camera frame rate in status bar will not reach zero if acquisition was stopped.

4 Release Notes BGAPI 2.3 SP 3

4.1 BGAPI
 Information
o Linux distribution Debian version 7.6 changed to Debian version 7.7
o Linux distribution Ubuntu 13.04 removed

4.1.1 Consumer
 No changes

4.1.2 GigE Interface


 Bugfixes
o Deadlock fixed, when closing the GigE producer

4.1.3 USB Interface


 No changes

4.1.4 Image processor


 No changes

4.2 Examples
 No changes

4.3 Doc
 No Changes

4.4 Tools
 CameraExplorer
o Improved GUI performance with LXG camera series in Dual Link

5 Release Notes BGAPI 2.3 SP 2

5.1 BGAPI
 Information
o Linux distribution Debian version 7.5 changed to Debian version 7.6

5.1.1 Consumer
 Enhancements
o Stability improved
o Device open error solved, if an interface object was opened before

8/15 Baumer Optronic GmbH


5.1.2 GigE Interface
 Bugfixes
o Interface name for GigE adapters under Linux OS corrected
 Enhancements
o Open device allows a second application to switchover the control, stream and message
channel
o Add Device feature AllowDeviceSwitchOver
o Add Device feature DeviceStreamChannelPacketSize
o Rename Device feature GevGVCPHeartbeatDisable into HeartbeatThreadDisable
o Speed up the camera discovery process
o Feature description of feature DevicePresent improved
o Access to features of node list improved after device reopen

5.1.3 USB Interface


 No changes

5.1.4 Image processor


 No changes

5.2 Examples
 Support for LXG cameras added

5.3 Doc
 ProgrammersGuide_BaumerFeatures.pdf
o Added description for the new features DeviceStreamChannelPacketSize,
AllowDeviceSwitchOver,
o Description for feature HeartbeatThreadDisable adjusted
o Description for DevicePresent adjusted
 bexplorer_help.pdf
o Info view description changed

5.4 Tools
 CameraExplorer
o Correct displaying IP addresses and MAC addresses in the feature tree
o Info view representation changed
o Crash when close the CameraExplorer fixed

 IPConfigTool
o Added support for LXG camera series

6 Release Notes BGAPI 2.3 SP 1

6.1 BGAPI

6.1.1 Consumer
 No changes.

9/15 Baumer Optronic GmbH


6.1.2 GigE Interface
 Bugfixes
o bug fix feature force ip during open remote device
o Heartbeat handling much more robust
o Improve pnp behavior
 Enhancements
o add Device feature DevicePresent
o add system feature GevFilterDrvVersion
o add system features for ActionCommand
ActionCommandWrite
ActionDeviceKey
ActionGevDeviceIP
ActionGevDeviceIPAdd
ActionGevDeviceIPRemove
ActionGevDeviceIPSelector
ActionGroupKey
ActionGroupMask
ActionInterfaceIP
ActionInterfaceIPAdd
ActionInterfaceIPRemove
ActionInterfaceIPSelector
ActionGevDeviceAckWait

o Support multi IP addresses on one interface


 Information
o New filter driver version 2.3.1.0 with improved resend mechanism,
Driver is furthermore backward compatible to former BGAPI versions, like 2.3, 2.2, 2.1. or 1.7.1

6.1.3 USB Interface


 Bugfixes
o Improved error handling for transmission errors avoids dead lock.
o added feature DevicePresent
6.1.4 Image processor
 Changes for RGB and BGR pixel formats.

6.2 Examples
 No changes.

6.3 Doc
ProgrammersGuide_BaumerFeatures
 added 2.1.1 Category: ActionControl

6.4 Tools
 CE improve presentation of info view

7 Release Notes BGAPI 2.3

10/15 Baumer Optronic GmbH


7.1 BGAPI
 Enhancements
o Supports additional Linux distributions: Ubuntu 14.04, Fedora 20 and OpenSuse 13

7.1.1 Consumer
 Information
o The function DataStream::GetBufferByIndex is deprecated and will be deleted in the next
version. Please use instead the BufferList class.

 Enhancements
o Event handler added.
This offers another way to retrieve images, device events and PnP events via call back
functions in C++ and delegates in C# for easy implementation.

new EventMode EVENTMODE_EVENT_HANDLER added


new function pointer / delegate PnPEventHandler added
function RegisterPnPEventHandler is implemented
new function pointer / delegate DeviceEventHandler added
function registerDeviceEventHanlder is implemented
new function pointer / delegate NewBufferEventHandler added
function RegisterNewBufferEventHandler is implemented

o Improved trace mechanism.


The trace data were written into pieces of 100 MB file size. Every piece is stored as a
compressed file. In maximum 400 pieces are allowed, this corresponds to a maximum trace
size of 40 GB.
Common system information, like OS version, memory usage, module versions added to trace
output.
o Buffer class provides new features to get the minimum and the maximum of the counter
returned by function GetFrameID. The following features can be accessed via the Node-
Interface:

FrameIDMax
FrameIDMin

7.1.2 GigE Interface


 Information
o New filter driver for new LXG cameras designed. Customer they are using filter driver, have to
update to the new version. The new filter driver is backward compatible to older BGAPI
versions, like 2.2, 2.1. or 1.7.1
 Enhancements
o GenTL conformity to V1.3
o Supports the new LXG camera series. The GigE interface now supports the Extended Chunk
Data Payload Type specified in GEV 1.2, which is used by the LXG camera series.
o Plug and Play mechanism further improved.

7.1.3 USB Interface


 Information

11/15 Baumer Optronic GmbH


o Restrict the allowed operating systems to Windows 7 or greater.

 Enhancements
o GenTL conformity to V1.3

7.1.4 Image processor


 Enhancements
o Supports the following new pixel formats R12p, G12p, B12p, BGR12p, R8, G8, B8

7.2 Examples
 Information
o The SDK Examples are divided into common and interface specific examples.

 Enhancements
o new examples PnPEventMode_Polling, ImageCaptureMode_Handler,
DeviceEventMode_Handler and PnPEventMode_Handler
o example ImagePolling_TriggerModeOff renamed to ImageCaptureMpde_Polling
o example GEV_HeartbeatTimeout renamed to HeartBeatTimeout
o example GEV_ForceIP renamed to ForceIP

7.3 Doc
 Information
o Added some new documents to facilitate the use of Baumer GAPI:

GenICam_Standard_Features_Naming_Convention V1.5.1, V2.0 and V2.1


GenICam_GenTL_SFNC V1.0
Users_Guide for our camera series HXG, MXG, MXU, SXG, TXG, VisiLine and VisiLine_IP
Product flyer for our digital industrial cameras.

 Enhancements
o New chapter: recommended working materials added.
o New diagram added, which displays the communication model used by Baumer GAPI.
o New chapters added to point 5. Application development with Baumer GAPI:

5.2 Information about System, Inferface, Device and DataStream


5.3 Parametrization of the camera

o Representation of code snippets for C++ and C# improved. The code snippets for C++ and
C# are under each other and are highlighted (C++ snippets yellow, C# snippets green)
o Color coding of main classes improved.

7.4 Tools
7.4.1 CameraExplorer

 Enhancements
o Simplified handling of Basic View
o Auto Exposure available in Basic View

12/15 Baumer Optronic GmbH


o Feature view added to source tab. This allows the user to control the System and Interface
features without opening a camera first.
o Image capture view revised.
o searching for cameras accelerated

8 Release Notes BGAPI 2.2 SP 1

8.1 BGAPI

8.1.1 Consumer
 No changes.

8.1.2 GigE Interface


 Bugfixes
o Camera discovery under Windows XP corrected.
o Configuration of resend parameter for dual GigE corrected.

8.1.3 USB Interface


 Bugfixes
o Improved error handling for transmission errors avoids dead lock.

8.1.4 Image processor


 No changes.

8.2 Examples
 No changes.

8.3 Doc
 No changes.

8.4 Tools
 No changes.

9 Release Notes BGAPI 2.2

9.1 BGAPI
 Enhancements
o Supports versions the following linux distributions: Debian 7.1, Ubuntu 12.04, Ubuntu 12.10,
Ubuntu 13.04 and Ubuntu 13.10
o Stability improved.

memory leaks fixed


plug'n play in multi camera systems stabilized

13/15 Baumer Optronic GmbH


9.1.1 Consumer
 Enhancements
o Some refresh functions of the list classes are changed. All Refresh functions of the list classes
uses a timeout value as parameter. For some main classes this parameter is useless, therefore
this parameter was removed for the functions SystemList::Refresh and DataStreamList::Refresh.
o Handling with main class objects improved. Now it is possible to get access from a main class
object to it's superordinate main class. E.g. when using a Device object there was no way to
get access to the Interface object on which the device is connected. To achieve this the main
classes provides the new function getParent:

Buffer::GetParent
DataStream::GetParent
Device::GetParent
Interface::GetParent

New functions added to check if a main class object is opened:

System::IsOpen
Interface::IsOpen
DataStream::IsOpen

o DeviceEvent, Image and ImageProcessor inherits from node interface. The classes DeviceEvent,
Image and ImageProcessor inherits from the node interface (class INode). For the class
DeviceEvent it is possible to access device event features specified in the GenICam XML file of
the device. For the Image and ImageProcessor classes it is possible to extend the functionality
without changing the class definition.
o Node interface extended. The class NodeMap provides now the iterator access like the list
classes and two new find functions for fast node searching. The following new functions were
declared:

class BGAPI2_DECL iterator


iterator begin();
iterator end();
iterator find(const String& _keyval);
bo_uint64 size();
Node* operator[](const String& val);
bo_bool GetNodePresent(String name);

The class Node defines a new function to get an increment of floating values:

Node::GetDoubleInc

o Device class extended. The Device class provides the new function GetSerialNumber to get the
serial number of the device. This function can also be used for identifying the device without
opening.
o Image class extended. New histogram function added to specify a ROI.
o Some functions renamed.

DataStream function renamed: Buffer::GetBufferID -> Buffer::GetBufferByIndex


System function renamed System::GetName -> System::GetFileName

14/15 Baumer Optronic GmbH


o Error handling improved. Two new exception classes were added. The ObjectInvalidException
is thrown if an BGAPI2 object is not valid or is no longer valid. The LowLevelException is
thrown, if a GenTL call to a GenTL producer failes. Some unused exception classes were
removed: InvalidIdException, IOException, SysVarMissingException.
o Preparation using event handler. The using of event handler is only prepared, but not
implemented yet. Therefore the following functions are not implemented and throw always
the NotImplementedException:
InterfaceEventControl::CancelGetPnPEvent
InterfaceEventControl::RegisterPnPEventHandler
DeviceEventControl::CancelGetDeviceEvent
DeviceEventControl::RegisterDeviceEventHandler
DataStreamEventControl::RegisterNewBufferEventHandler

9.1.2 GigE Interface


 No changes.

9.1.3 USB Interface


 Information
o Supports USB3 Vision devices for Windows

9.1.4 Image processor


 No changes.

9.2 Examples
 No changes.

9.3 Doc
 No changes.

9.4 Tools
 No changes.

15/15 Baumer Optronic GmbH

You might also like