Pylon::CCameraEventHandler#

Module: Instant Camera

The camera event handler base class.

#include <pylon/CameraEventHandler.h>

Public Functions#

Public Functions Documentation#

function OnCameraEvent#

inline virtual void OnCameraEvent(
    CInstantCamera & camera,
    intptr_t userProvidedId,
    GenApi::INode * pNode
)

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

Parameters:

• camera The source of the call.
• userProvidedId The ID passed when registering for the event. It can be used to distinguish between different events.
• 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.

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

function OnCameraEventHandlerRegistered#

inline virtual void OnCameraEventHandlerRegistered(
    CInstantCamera & camera,
    const String_t & nodeName,
    intptr_t userProvidedId
)

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

Parameters:

• camera The source of the call.
• nodeName The name of the event data node updated on camera event, e.g. "ExposureEndEventTimestamp" for exposure end event.
• 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.

function OnCameraEventHandlerDeregistered#

inline virtual void OnCameraEventHandlerDeregistered(
    CInstantCamera & camera,
    const String_t & nodeName,
    intptr_t userProvidedId
)

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

Parameters:

• camera The source of the call.
• nodeName The name of the event data node updated on camera event, e.g. "ExposureEndEventTimestamp" for exposure end event.
• 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.

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

function DestroyCameraEventHandler#

inline virtual void DestroyCameraEventHandler()

Destroys the camera event handler.

Error Safety:

C++ exceptions from this call will be caught and ignored.

function CCameraEventHandler#

inline CCameraEventHandler()

Create.

function CCameraEventHandler#

inline CCameraEventHandler(
    const CCameraEventHandler &
)

Copy.

function operator=#

inline CCameraEventHandler & operator=(
    const CCameraEventHandler &
)

Assign.

function ~CCameraEventHandler#

inline virtual ~CCameraEventHandler()

Destruct.