All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Pylon::CBaslerUsbCameraEventHandler Class Reference

The camera event handler base class. More...

#include <pylon/usb/BaslerUsbCameraEventHandler.h>

Public Member Functions

virtual void OnCameraEvent (CBaslerUsbInstantCamera &camera, intptr_t userProvidedId, GenApi::INode *pNode)
 This method is called when a camera event has been received. More...
 
virtual void OnCameraEventHandlerRegistered (CBaslerUsbInstantCamera &camera, const String_t &nodeName, intptr_t userProvidedId)
 This method is called when the camera event handler has been registered. More...
 
virtual void OnCameraEventHandlerDeregistered (CBaslerUsbInstantCamera &camera, const String_t &nodeName, intptr_t userProvidedId)
 This method is called when the camera event handler has been deregistered. More...
 
virtual void DestroyCameraEventHandler ()
 Destroys the camera event handler. More...
 
 CBaslerUsbCameraEventHandler ()
 Create.
 
 CBaslerUsbCameraEventHandler (const CBaslerUsbCameraEventHandler &)
 Copy.
 
CBaslerUsbCameraEventHandleroperator= (const CBaslerUsbCameraEventHandler &)
 Assign.
 
virtual ~CBaslerUsbCameraEventHandler ()
 Destruct.
 

Detailed Description

The camera event handler base class.

Member Function Documentation

virtual void Pylon::CBaslerUsbCameraEventHandler::DestroyCameraEventHandler ( )
inlinevirtual

Destroys the camera event handler.

Error Safety:
C++ exceptions from this call will be caught and ignored.
virtual void Pylon::CBaslerUsbCameraEventHandler::OnCameraEvent ( CBaslerUsbInstantCamera camera,
intptr_t  userProvidedId,
GenApi::INode *  pNode 
)
inlinevirtual

This method is called when a camera event has been received.

Only very short processing tasks should be performed by this method. Otherwise, the event notification will block the processing of images.

Parameters
[in]cameraThe source of the call.
[in]userProvidedIdThe ID passed when registering for the event. It can be used to distinguish between different events.
[in]pNodeThe node identified by node name when registering.
Error Safety:
C++ exceptions from this call will be caught and ignored. All event handlers are notified.
Thread Safety:
This method is called outside the lock of the camera object, outside the lock of the node map, and inside the lock of the camera event handler registry.
virtual void Pylon::CBaslerUsbCameraEventHandler::OnCameraEventHandlerDeregistered ( CBaslerUsbInstantCamera camera,
const String_t nodeName,
intptr_t  userProvidedId 
)
inlinevirtual

This method is called when the camera event handler has been deregistered.

The camera event handler is automatically deregistered when the Instant Camera object is destroyed.

Parameters
[in]cameraThe source of the call.
[in]nodeNameThe name of the event data node updated on camera event, e.g. "ExposureEndEventTimestamp" for exposure end event.
[in]userProvidedIdThis ID is passed as a parameter in CBaslerUsbCameraEventHandler::OnCameraEvent and can be used to distinguish between different events.
Error Safety:
C++ exceptions from this call will be caught and ignored.
Thread Safety:
This method is called inside the lock of the camera event handler registry.
virtual void Pylon::CBaslerUsbCameraEventHandler::OnCameraEventHandlerRegistered ( CBaslerUsbInstantCamera camera,
const String_t nodeName,
intptr_t  userProvidedId 
)
inlinevirtual

This method is called when the camera event handler has been registered.

Parameters
[in]cameraThe source of the call.
[in]nodeNameThe name of the event data node updated on camera event, e.g. "ExposureEndEventTimestamp" for exposure end event.
[in]userProvidedIdThis ID is passed as a parameter in CBaslerUsbCameraEventHandler::OnCameraEvent and can be used to distinguish between different events.
Error Safety:
Exceptions from this call will propagate through.
Thread Safety:
This method is called inside the lock of the camera event handler registry.

The documentation for this class was generated from the following file:

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:29)