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

The class PnPEvent represented a plug'n play event and provides access to the event information. More...

#include <bgapi2_genicam.hpp>

Public Member Functions

 PnPEvent ()
 Constructor for creating an PnPEvent object.
 
 ~PnPEvent ()
 Destructor for deleting an PnPEvent object.
 
String GetSerialNumber ()
 This function delivers the serial number of the Device object which was added/removed from the Interface object. More...
 
PnPType GetPnPType ()
 This function delivers the kind of the PnPEvent. The two several kinds of PnPEvent are defined in enumeration Events::PnPType. More...
 
String GetId ()
 This function delivers the event ID of the PnPEvent. More...
 

Friends

class InterfaceEventControl
 

Detailed Description

The class PnPEvent represented a plug'n play event and provides access to the event information.

Definition at line 1831 of file bgapi2_genicam.hpp.

Member Function Documentation

◆ GetId()

BGAPI2::Events::PnPEvent::GetId ( )

This function delivers the event ID of the PnPEvent.

Returns
String The ID of the PnPevent in string format.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::NotAvailableExceptionThe ID of the PnPEvent was not included.

◆ GetPnPType()

BGAPI2::Events::PnPEvent::GetPnPType ( )

This function delivers the kind of the PnPEvent. The two several kinds of PnPEvent are defined in enumeration Events::PnPType.

Returns
PnPType The kind of the PnPEvent.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.

◆ GetSerialNumber()

BGAPI2::Events::PnPEvent::GetSerialNumber ( )

This function delivers the serial number of the Device object which was added/removed from the Interface object.

Returns
String The serial number of the Device object which was add/removed from the Interface object.
Exceptions
Exceptions::ObjectInvalidExceptionThe calling object is not valid.
Exceptions::NotAvailableExceptionThe serial number 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