The image event handler base class.
More...
#include <pylon/ImageEventHandler.h>
The image event handler base class.
virtual void Pylon::CImageEventHandler::DestroyImageEventHandler |
( |
| ) |
|
|
inlinevirtual |
Destroys the image event handler.
- Error Safety:
- C++ exceptions from this call will be caught and ignored.
virtual void Pylon::CImageEventHandler::OnImageEventHandlerDeregistered |
( |
CInstantCamera & |
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] | camera | The 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::CImageEventHandler::OnImageEventHandlerRegistered |
( |
CInstantCamera & |
camera | ) |
|
|
inlinevirtual |
This method is called when the image event handler has been registered.
- Parameters
-
[in] | camera | The 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.
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] | camera | The source of the call. |
[in] | grabResult | The 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::CImageEventHandler::OnImagesSkipped |
( |
CInstantCamera & |
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] | camera | The source of the call. |
[in] | countOfSkippedImages | The 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: