All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
List of all members
Pylon::CEventGrabberProxyT< TParams > Class Template Reference

Low Level API: The event grabber class with parameter access methods. More...

#include <pylon/EventGrabberProxy.h>

Inheritance diagram for Pylon::CEventGrabberProxyT< TParams >:
Inheritance graph
[legend]

Public Member Functions

Construction
 CEventGrabberProxyT ()
 Creates a CEventGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon event grabber.
 
 CEventGrabberProxyT (Pylon::IEventGrabber *)
 Creates a CEventGrabberProxyT object and attaches it to a pylon event grabber.
 
virtual ~CEventGrabberProxyT ()
 Destructor.
 
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.
 
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...
 
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.
 
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...
 

Detailed Description

template<class TParams>
class Pylon::CEventGrabberProxyT< TParams >

Low Level API: The event grabber class with parameter access methods.

This is the base class for pylon event grabber providing access to configuration parameters.

See Also
Accessing Parameters
Template Parameters
TParamsThe specific parameter class (auto generated from the parameter xml file)

Member Function Documentation

template<class TParams>
void Pylon::CEventGrabberProxyT< TParams >::Close ( )
inline

Close the event grabber.

template<class TParams>
GenApi::INode* Pylon::CNodeMapProxyT< TParams >::GetNode ( const GenICam::gcstring Name) const
inlineinherited

Retrieves the node from the central map by Name.

template<class TParams>
GenApi::INodeMap* Pylon::CEventGrabberProxyT< TParams >::GetNodeMap ( )
inline

Return the associated event grabber parameters.

If no parameters are available, NULL is returned.

template<class TParams>
void Pylon::CNodeMapProxyT< TParams >::GetNodes ( GenApi::NodeList_t Nodes) const
inlineinherited

Retrieves all nodes in the node map.

template<class TParams>
WaitObject& Pylon::CEventGrabberProxyT< TParams >::GetWaitObject ( ) const
inline

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.

template<class TParams>
void Pylon::CNodeMapProxyT< TParams >::InvalidateNodes ( ) const
inlineinherited

Invalidates all nodes.

template<class TParams>
bool Pylon::CEventGrabberProxyT< TParams >::IsOpen ( ) const
inline

Retrieve whether the event grabber is open.

template<class TParams>
void Pylon::CEventGrabberProxyT< TParams >::Open ( )
inline

Open the event grabber.

template<class TParams>
void Pylon::CNodeMapProxyT< TParams >::Poll ( int64_t  ElapsedTime)
inlineinherited

Fires nodes which have a polling time.

template<class TParams>
bool Pylon::CEventGrabberProxyT< TParams >::RetrieveEvent ( EventResult Result)
inline

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 class was generated from the following file:

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