![]() |
Programmer's Guide Baumer GAPI SDK Reference v2.10.0
|
The class Interface represents a physical interface, e.g. GEV or a logical interface, such as USB and belongs to the BGAPI2 main classes. More...
#include <bgapi2_genicam.hpp>
Public Member Functions | |
void | Open () |
This function opens the interface object and make their functions available. Exceptions are the info-functions, which are already available before opening the interface. More... | |
void | Close () |
This function closes the interface object and releases the used resources. More... | |
bo_bool | IsOpen () |
This function delivers true, if the interface is opened. More... | |
DeviceList * | GetDevices () |
This function delivers the device list of the interface. More... | |
String | GetID () |
This function delivers the unique string identifier of the Interface, which is used in the InterfaceList. More... | |
String | GetDisplayName () |
This function delivers a meaningful name of the Interface for display only. More... | |
String | GetTLType () |
This function delivers the transport layer type of the Interface. More... | |
System * | GetParent () |
This function delivers the superordinate System object. More... | |
![]() | |
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 | RegisterPnPEvent (EventMode eventMode) |
This function registers a PnPEvent at an Interface object to detect adding and removing of Device objects. More... | |
void | UnregisterPnPEvent () |
This function unregisters a PnPEvent at an Interface object. More... | |
bo_bool | GetPnPEvent (PnPEvent *pPnPEvent, bo_uint64 iTimeout) |
This function fetches a PnPEvent from the Interface object. More... | |
void | CancelGetPnPEvent () |
This function cancels the current waiting operation on the GetPnPEvent function. More... | |
void | RegisterPnPEventHandler (void *callBackOwner, PnPEventHandler pFunc) |
Register a callback function which is called any time a new plug 'n play event 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 | InterfaceList |
class | DeviceList |
class | Device |
The class Interface represents a physical interface, e.g. GEV or a logical interface, such as USB and belongs to the BGAPI2 main classes.
Definition at line 3033 of file bgapi2_genicam.hpp.
BGAPI2::Interface::Close | ( | ) |
This function closes the interface 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::Interface::GetDevices | ( | ) |
This function delivers the device list of the interface.
Exceptions::NotInitializedException | The interface object is not open. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Interface::GetDisplayName | ( | ) |
This function delivers a meaningful name of the Interface 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::Interface::GetID | ( | ) |
This function delivers the unique string identifier of the Interface, which is used in the InterfaceList.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Interface::GetParent | ( | ) |
BGAPI2::Interface::GetTLType | ( | ) |
This function delivers the transport layer type of the Interface.
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::Interface::IsOpen | ( | ) |
This function delivers true, if the interface is opened.
Exceptions::ObjectInvalidException | The calling object is not valid. |
BGAPI2::Interface::Open | ( | ) |
This function opens the interface object and make their functions available. Exceptions are the info-functions, which are already available before opening the interface.
Exceptions::ResourceInUseException | This exception will be thrown if the interface object is already open. |
Exceptions::ObjectInvalidException | The calling object is not valid. |
Exceptions::NotInitializedException | The corresponding system object is not initialized. |
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