Pylon::IEventGrabber#

Low Level API: Interface of an object receiving asynchronous events. More…

#include <pylon/EventGrabber.h>

Public Functions#

	Name
virtual void	Open() =0 Open the event grabber.
virtual void	Close() =0 Close the event grabber.
virtual bool	IsOpen() const =0 Retrieve whether the event grabber is open.
virtual bool	RetrieveEvent(EventResult & ) =0 Retrieve an event message from the output queue.
virtual WaitObject &	GetWaitObject() const =0 Return the event object associated with the grabber.
virtual GenApi::INodeMap *	GetNodeMap() =0 Return the associated event grabber parameters.

Detailed Description#

class Pylon::IEventGrabber;

Low Level API: Interface of an object receiving asynchronous events.

Asynchronous event messages are received from the camera. Internal Buffers are filled and stored in an output queue. While the output queue contains data the associated waitobject is signaled.

With RetrieveEvent() the first event message is copied into a user buffer.

Public Functions Documentation#

function Open#

virtual void Open() =0

Open the event grabber.

function Close#

virtual void Close() =0

Close the event grabber.

function IsOpen#

virtual bool IsOpen() const =0

Retrieve whether the event grabber is open.

function RetrieveEvent#

virtual bool RetrieveEvent(
    EventResult & 
) =0

Retrieve an event message from the output queue.

Return: When the event was available true is returned and the event message is copied into the EventResult.

function GetWaitObject#

virtual WaitObject & GetWaitObject() const =0

Return the event object associated with the grabber.

This object get signaled as soon as a event has occurred. It will be reset when the output queue is empty.

function GetNodeMap#

virtual GenApi::INodeMap * GetNodeMap() =0

Return the associated event grabber parameters.

If no parameters are available, NULL is returned.