The camera event handler base class.
More...
#include <pylon/CameraEventHandler.h>
The camera event handler base class.
virtual void Pylon::CCameraEventHandler::DestroyCameraEventHandler |
( |
| ) |
|
|
inlinevirtual |
Destroys the camera event handler.
- Error Safety:
- C++ exceptions from this call will be caught and ignored.
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] | camera | The source of the call. |
[in] | userProvidedId | The ID passed when registering for the event. It can be used to distinguish between different events. |
[in] | pNode | The 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::CCameraEventHandler::OnCameraEventHandlerDeregistered |
( |
CInstantCamera & |
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] | camera | The source of the call. |
[in] | nodeName | The name of the event data node updated on camera event, e.g. "ExposureEndEventTimestamp" for exposure end event. |
[in] | userProvidedId | This ID is passed as a parameter in CCameraEventHandler::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::CCameraEventHandler::OnCameraEventHandlerRegistered |
( |
CInstantCamera & |
camera, |
|
|
const String_t & |
nodeName, |
|
|
intptr_t |
userProvidedId |
|
) |
| |
|
inlinevirtual |
This method is called when the camera event handler has been registered.
- Parameters
-
[in] | camera | The source of the call. |
[in] | nodeName | The name of the event data node updated on camera event, e.g. "ExposureEndEventTimestamp" for exposure end event. |
[in] | userProvidedId | This ID is passed as a parameter in CCameraEventHandler::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: