Skip to content

Pylon::IEventGrabber#

Module: Low Level API

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

#include <pylon/EventGrabber.h>

Public Functions#

Name
virtual void Open()
Open the event grabber.
virtual void Close()
Close the event grabber.
virtual bool IsOpen() const
Retrieve whether the event grabber is open.
virtual bool RetrieveEvent(EventResult & )
Retrieve an event message from the output queue.
virtual WaitObject & GetWaitObject() const
Return the event object associated with the grabber.
virtual GenApi::INodeMap * GetNodeMap()
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#

Open#

virtual void Open() 

Open the event grabber.

Close#

virtual void Close() 

Close the event grabber.

IsOpen#

virtual bool IsOpen() const 

Retrieve whether the event grabber is open.

RetrieveEvent#

virtual bool RetrieveEvent(
    EventResult & 
) 

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.

GetWaitObject#

virtual WaitObject & GetWaitObject() const 

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.

GetNodeMap#

virtual GenApi::INodeMap * GetNodeMap() 

Return the associated event grabber parameters.

If no parameters are available, NULL is returned.


Updated on 5 July 2022 at 15:30:01