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

This class represents an device event which was received from the host. Use this class to get event information. More...

#include <bgapi2_genicam.hpp>

Inheritance diagram for BGAPI2::Events::DeviceEvent:
BGAPI2::INode

Public Member Functions

 DeviceEvent ()
 Constructor for creating an DeviceEvent object.
 
 ~DeviceEvent ()
 Destructor for deleting an DeviceEvent object.
 
String GetName ()
 This function delivers the name of the DeviceEvent, which was specified in the XML description of the event. More...
 
String GetDisplayName ()
 This function delivers the display name of the DeviceEvent, which was specified in the XML description of the event. More...
 
bo_uint64 GetTimeStamp ()
 This function delivers the timestamp of the DeviceEvent. More...
 
String GetId ()
 This function delivers the ID of the DeviceEvent, which was specified in the XML description of the event. More...
 
- 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...
 

Friends

class DeviceEventControl
 

Detailed Description

This class represents an device event which was received from the host. Use this class to get event information.

Definition at line 1951 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ GetDisplayName()

BGAPI2::Events::DeviceEvent::GetDisplayName ( )

This function delivers the display name of the DeviceEvent, which was specified in the XML description of the event.

Returns
String The display name of the device event.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::NotAvailableExceptionThe display name was not included in the XML description of the event.

◆ GetId()

BGAPI2::Events::DeviceEvent::GetId ( )

This function delivers the ID of the DeviceEvent, which was specified in the XML description of the event.

Returns
String The ID of the device event in String format.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::NoDataExceptionThe event includes no data.

◆ GetName()

BGAPI2::Events::DeviceEvent::GetName ( )

This function delivers the name of the DeviceEvent, which was specified in the XML description of the event.

Returns
String The name of the device event.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::NotAvailableExceptionThe name was not included in the event.

◆ GetTimeStamp()

BGAPI2::Events::DeviceEvent::GetTimeStamp ( )

This function delivers the timestamp of the DeviceEvent.

Returns
bo_uint64 The timestamp of the device event.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::NotAvailableExceptionThe timestamp was not included in the event.

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