All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Public Member Functions | List of all members
Pylon::IEventGrabber Interface Referenceabstract

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

#include <pylon/EventGrabber.h>

Public Member Functions

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. More...
 
virtual WaitObjectGetWaitObject () const =0
 Return the event object associated with the grabber. More...
 
virtual GenApi::INodeMap * GetNodeMap ()=0
 Return the associated event grabber parameters. More...
 

Detailed Description

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.

Member Function Documentation

virtual GenApi::INodeMap* Pylon::IEventGrabber::GetNodeMap ( )
pure virtual

Return the associated event grabber parameters.

If no parameters are available, NULL is returned.

virtual WaitObject& Pylon::IEventGrabber::GetWaitObject ( ) const
pure virtual

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.

virtual bool Pylon::IEventGrabber::RetrieveEvent ( EventResult )
pure virtual

Retrieve an event message from the output queue.

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

The documentation for this interface was generated from the following file:

pylon 5.0.5
Copyright © 2006-2016 Basler AG (Thu Aug 11 2016 18:01:28)