![]() |
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
|
The class System is the abstraction of a Producer and belongs to the BGAPI2 main classes. More...
#include <bgapi2_genicam.hpp>
Public Member Functions | |
System (String filepath) | |
This constructor sets the path to the producer file. More... | |
~System () | |
The destructor. | |
void | Open () |
This function opens the system object and makes their functions available. Exceptions are the info-functions, which are already available before opening the system. More... | |
void | Close () |
This function closes the system object and releases the used resources. More... | |
bo_bool | IsOpen () |
This function delivers true, if the system is opened. More... | |
InterfaceList * | GetInterfaces () |
This function delivers the interface list of the system. More... | |
String | GetID () |
This function delivers the unique string identifier of the System which is used in the SystemList. More... | |
String | GetVendor () |
This function delivers the name of the GenTL producer vendor. More... | |
String | GetModel () |
This function delivers the name of the GenTL producer to distinguish different kinds of GenTL Producer implementations. More... | |
String | GetVersion () |
This function delivers the GenTL Producer version. More... | |
String | GetTLType () |
This function delivers the transport layer type of the GenTL Producer. More... | |
String | GetFileName () |
This function delivers the file name of the GenTL Producer. More... | |
String | GetPathName () |
This function delivers the full path to the GenTL Producer including filename. More... | |
String | GetDisplayName () |
This function delivers a meaningful name of the GenTL Producer for display only. 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... | |
![]() | |
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 | SystemList |
class | InterfaceList |
class | Interface |
The class System is the abstraction of a Producer and belongs to the BGAPI2 main classes.
Definition at line 3119 of file bgapi2_genicam.hpp.
BGAPI2::System::System | ( | String | filepath | ) |
This constructor sets the path to the producer file.
filepath | The path including filename of GenTL producer to be loaded. |
BGAPI2::System::Close | ( | ) |
This function closes the system 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::System::GetDisplayName | ( | ) |
This function delivers a meaningful name of the GenTL Producer for display only.
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::System::GetFileName | ( | ) |
This function delivers the file name of the GenTL Producer.
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::System::GetID | ( | ) |
This function delivers the unique string identifier of the System which is used in the SystemList.
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::System::GetInterfaces | ( | ) |
This function delivers the interface list of the system.
Exceptions::NotInitializedException | The system object is not opened. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::System::GetModel | ( | ) |
This function delivers the name of the GenTL producer to distinguish different kinds of GenTL Producer implementations.
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::System::GetPathName | ( | ) |
This function delivers the full path to the GenTL Producer including filename.
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::System::GetTLType | ( | ) |
This function delivers the transport layer type of the GenTL Producer.
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::System::GetVendor | ( | ) |
This function delivers the name of the GenTL producer vendor.
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::System::GetVersion | ( | ) |
This function delivers the GenTL Producer version.
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::System::IsOpen | ( | ) |
This function delivers true, if the system is opened.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::System::Open | ( | ) |
This function opens the system object and makes their functions available. Exceptions are the info-functions, which are already available before opening the system.
Exceptions::ResourceInUseException | This exception will be thrown if the system 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. |
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