All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Pylon::CPylonGigEEventGrabber Class Reference

Low Level API: Class for pylon GigE Vision cameras providing access to event grabber related methods and parameters. More...

#include <pylon/gige/PylonGigECamera.h>

Inheritance diagram for Pylon::CPylonGigEEventGrabber:
Inheritance graph
[legend]

Public Member Functions

Construction
 CPylonGigEEventGrabber ()
 Creates a CEventGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon event grabber. More...
 
 CPylonGigEEventGrabber (Pylon::IEventGrabber *pEventGrabber)
 Creates a CEventGrabberProxyT object and attaches it to a pylon event grabber. More...
 
Some smart pointer functionality
virtual void Attach (IEventGrabber *)
 Attach a pylon event grabber.
 
virtual bool IsAttached () const
 Checks if a pylon stream grabber is attached.
 
virtual IEventGrabberGetEventGrabber () const
 Returns the pylon event grabber interface pointer.
 
Some smart pointer functionality
virtual void Attach (GenApi::INodeMap *, bool replace=false)
 Attach a pylon node map.
 
virtual GenApi::INodeMapGetNodeMap () const
 Returns the pylon node map interface pointer.
 
Implementation of the IEventGrabber interface

See Pylon::IEventGrabber for more details.

void Open ()
 Open the event grabber. More...
 
void Close ()
 Close the event grabber. More...
 
bool IsOpen () const
 Retrieve whether the event grabber is open. More...
 
bool RetrieveEvent (EventResult &Result)
 Retrieve an event message from the output queue. More...
 
WaitObjectGetWaitObject () const
 Return the event object associated with the grabber. More...
 
GenApi::INodeMapGetNodeMap ()
 Return the associated event grabber parameters. More...
 
Partial implementation of the INodeMap interface

See GENAPI_NAMESPACE::INodeMap for more details

void GetNodes (GenApi::NodeList_t &Nodes) const
 Retrieves all nodes in the node map. More...
 
GenApi::INodeGetNode (const GenICam::gcstring &Name) const
 Retrieves the node from the central map by Name. More...
 
void InvalidateNodes () const
 Invalidates all nodes. More...
 
void Poll (int64_t ElapsedTime)
 Fires nodes which have a polling time. More...
 

Public Attributes

Root - GigE event parameters
GenApi::IIntegerNumBuffer
 Number of buffers to be used. More...
 
GenApi::IIntegerTimeout
 Acknowledge timeout in milliseconds. More...
 
GenApi::IIntegerRetryCount
 Maximum number of retries. More...
 
Debug - For internal use only.
GenApi::IEnumerationT
< StatusEnums > & 
Status
 For internal use only. More...
 

Detailed Description

Low Level API: Class for pylon GigE Vision cameras providing access to event grabber related methods and parameters.

See Also
Accessing Parameters

Constructor & Destructor Documentation

Pylon::CPylonGigEEventGrabber::CPylonGigEEventGrabber ( )
inline

Creates a CEventGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon event grabber.

Pylon::CPylonGigEEventGrabber::CPylonGigEEventGrabber ( Pylon::IEventGrabber pEventGrabber)
inline

Creates a CEventGrabberProxyT object and attaches it to a pylon event grabber.

Member Function Documentation

Close the event grabber.

Retrieves the node from the central map by Name.

Return the associated event grabber parameters.

If no parameters are available, NULL is returned.

Retrieves all nodes in the node map.

WaitObject& Pylon::CEventGrabberProxyT< Basler_GigEEventParams::CGigEEventParams_Params >::GetWaitObject ( void  ) const
inlineinherited

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.

void Pylon::CNodeMapProxyT< Basler_GigEEventParams::CGigEEventParams_Params >::InvalidateNodes ( ) const
inlineinherited

Invalidates all nodes.

bool Pylon::CEventGrabberProxyT< Basler_GigEEventParams::CGigEEventParams_Params >::IsOpen ( void  ) const
inlineinherited

Retrieve whether the event grabber is open.

Open the event grabber.

void Pylon::CNodeMapProxyT< Basler_GigEEventParams::CGigEEventParams_Params >::Poll ( int64_t  ElapsedTime)
inlineinherited

Fires nodes which have a polling time.

bool Pylon::CEventGrabberProxyT< Basler_GigEEventParams::CGigEEventParams_Params >::RetrieveEvent ( EventResult Result)
inlineinherited

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.

Member Data Documentation

GenApi::IInteger& Basler_GigEEventParams::CGigEEventParams_Params::NumBuffer
inherited

Number of buffers to be used.

Number of Buffers that are going to be used receiving events. .

Visibility = Expert

GenApi::IInteger& Basler_GigEEventParams::CGigEEventParams_Params::RetryCount
inherited

Maximum number of retries.

Number retry attempts by the camera to get an acknowledge for a sent event message.

Visibility = Expert

GenApi::IEnumerationT<StatusEnums >& Basler_GigEEventParams::CGigEEventParams_Params::Status
inherited

For internal use only.

Visibility = Guru

GenApi::IInteger& Basler_GigEEventParams::CGigEEventParams_Params::Timeout
inherited

Acknowledge timeout in milliseconds.

Time to wait by the camera if an acknowledge request is configured (RetryCount != 0) to wait until the acknowledge arrives before resending the event message on its own.

Visibility = Expert


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

pylon 5.0.9
Copyright © 2006-2017 Basler AG (Tue May 30 2017 17:24:58)