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

The image event handler base class. More...

#include <pylon/usb/BaslerUsbImageEventHandler.h>

Public Member Functions

virtual void OnImagesSkipped (CBaslerUsbInstantCamera &camera, size_t countOfSkippedImages)
 This method is called when images have been skipped using the GrabStrategy_LatestImageOnly strategy or the GrabStrategy_LatestImages strategy. More...
 
virtual void OnImageGrabbed (CBaslerUsbInstantCamera &camera, const CBaslerUsbGrabResultPtr &grabResult)
 This method is called when an image has been grabbed. More...
 
virtual void OnImageEventHandlerRegistered (CBaslerUsbInstantCamera &camera)
 This method is called when the image event handler has been registered. More...
 
virtual void OnImageEventHandlerDeregistered (CBaslerUsbInstantCamera &camera)
 This method is called when the image event handler has been deregistered. More...
 
virtual void DestroyImageEventHandler ()
 Destroys the image event handler. More...
 
 CBaslerUsbImageEventHandler ()
 Create.
 
 CBaslerUsbImageEventHandler (const CBaslerUsbImageEventHandler &)
 Copy.
 
CBaslerUsbImageEventHandleroperator= (const CBaslerUsbImageEventHandler &)
 Assign.
 
virtual ~CBaslerUsbImageEventHandler ()
 Destruct.
 

Detailed Description

The image event handler base class.

Member Function Documentation

virtual void Pylon::CBaslerUsbImageEventHandler::DestroyImageEventHandler ( )
inlinevirtual

Destroys the image event handler.

Error Safety:
C++ exceptions from this call will be caught and ignored.
virtual void Pylon::CBaslerUsbImageEventHandler::OnImageEventHandlerDeregistered ( CBaslerUsbInstantCamera camera)
inlinevirtual

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

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

Parameters
[in]cameraThe source of the call.
Error Safety:
C++ exceptions from this call will be caught and ignored.
Thread Safety:
This method is called inside the lock of the image event handler registry.
virtual void Pylon::CBaslerUsbImageEventHandler::OnImageEventHandlerRegistered ( CBaslerUsbInstantCamera camera)
inlinevirtual

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

Parameters
[in]cameraThe source of the call.
Error Safety:
Exceptions from this call will propagate through.
Thread Safety:
This method is called inside the lock of the image event handler registry.
virtual void Pylon::CBaslerUsbImageEventHandler::OnImageGrabbed ( CBaslerUsbInstantCamera camera,
const CBaslerUsbGrabResultPtr grabResult 
)
inlinevirtual

This method is called when an image has been grabbed.

The grab result smart pointer passed does always reference a grab result data object. The status of the grab needs to be checked before accessing the grab result data. See CGrabResultData::GrabSucceeded(), CGrabResultData::GetErrorCode() and CGrabResultData::GetErrorDescription() for more information.

Parameters
[in]cameraThe source of the call.
[in]grabResultThe grab result data.
Error Safety:
Exceptions from this call will propagate through. The notification of event handlers stops when an exception is triggered.
Thread Safety:
This method is called outside the lock of the camera object but inside the lock of the image event handler registry.
virtual void Pylon::CBaslerUsbImageEventHandler::OnImagesSkipped ( CBaslerUsbInstantCamera camera,
size_t  countOfSkippedImages 
)
inlinevirtual

This method is called when images have been skipped using the GrabStrategy_LatestImageOnly strategy or the GrabStrategy_LatestImages strategy.

Parameters
[in]cameraThe source of the call.
[in]countOfSkippedImagesThe number of images skipped. This countOfSkippedImages does not include the number of images lost in the case of a buffer under run in the driver.
Error Safety:
Exceptions from this call will propagate through. The notification of event handlers stops when an exception is triggered.
Thread Safety:
This method is called outside the lock of the camera object but inside the lock of the image event handler registry.

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

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:59)