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

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

#include <pylon/usb/PylonUsbCamera.h>

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

Public Member Functions

Construction
 CPylonUsbEventGrabber ()
 Creates a CEventGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon event grabber. More...
 
 CPylonUsbEventGrabber (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 - USB event grabber parameters.
GenApi::IIntegerNumBuffer
 Number of buffers to be used. More...
 
GenApi::IIntegerNumMaxQueuedUrbs
 The maximum number of requests to be enqueued to the driver. More...
 
GenApi::IIntegerTransferLoopThreadPriority
 The priority of the thread that handles USB requests of the event stream interface. More...
 
Statistic - Statistical data.
GenApi::IIntegerStatistic_Total_Event_Count
 The total count of processed events. More...
 
GenApi::IIntegerStatistic_Failed_Event_Count
 The count of processed events with an error status. More...
 
GenApi::IIntegerStatistic_Last_Failed_Event_Buffer_Status
 The status code of the last failed event buffer. More...
 

Detailed Description

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

See Also
Accessing Parameters

Constructor & Destructor Documentation

Pylon::CPylonUsbEventGrabber::CPylonUsbEventGrabber ( )
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::CPylonUsbEventGrabber::CPylonUsbEventGrabber ( 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.

void Pylon::CNodeMapProxyT< Basler_UsbEventParams::CUsbEventParams_Params >::GetNodes ( GenApi::NodeList_t Nodes) const
inlineinherited

Retrieves all nodes in the node map.

WaitObject& Pylon::CEventGrabberProxyT< Basler_UsbEventParams::CUsbEventParams_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_UsbEventParams::CUsbEventParams_Params >::InvalidateNodes ( ) const
inlineinherited

Invalidates all nodes.

bool Pylon::CEventGrabberProxyT< Basler_UsbEventParams::CUsbEventParams_Params >::IsOpen ( void  ) const
inlineinherited

Retrieve whether the event grabber is open.

Open the event grabber.

void Pylon::CNodeMapProxyT< Basler_UsbEventParams::CUsbEventParams_Params >::Poll ( int64_t  ElapsedTime)
inlineinherited

Fires nodes which have a polling time.

bool Pylon::CEventGrabberProxyT< Basler_UsbEventParams::CUsbEventParams_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_UsbEventParams::CUsbEventParams_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_UsbEventParams::CUsbEventParams_Params::NumMaxQueuedUrbs
inherited

The maximum number of requests to be enqueued to the driver.

Visibility = Guru

GenApi::IInteger& Basler_UsbEventParams::CUsbEventParams_Params::Statistic_Failed_Event_Count
inherited

The count of processed events with an error status.

Visibility = Expert

GenApi::IInteger& Basler_UsbEventParams::CUsbEventParams_Params::Statistic_Last_Failed_Event_Buffer_Status
inherited

The status code of the last failed event buffer.

Visibility = Expert

GenApi::IInteger& Basler_UsbEventParams::CUsbEventParams_Params::Statistic_Total_Event_Count
inherited

The total count of processed events.

Visibility = Expert

GenApi::IInteger& Basler_UsbEventParams::CUsbEventParams_Params::TransferLoopThreadPriority
inherited

The priority of the thread that handles USB requests of the event stream interface.

Visibility = Guru


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:59)