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

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

#include <pylon/StreamGrabberProxy.h>

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

Public Member Functions

Construction
 CStreamGrabberProxyT ()
 Creates a CStreamGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon stream grabber.
 
 CStreamGrabberProxyT (Pylon::IStreamGrabber *)
 Creates a CStreamGrabberProxyT object and attaches it to a pylon stream grabber.
 
virtual ~CStreamGrabberProxyT ()
 Destructor.
 
Some smart pointer functionality
virtual void Attach (IStreamGrabber *)
 Attach a pylon stream grabber.
 
virtual bool IsAttached () const
 Checks if a pylon stream grabber is attached.
 
virtual IStreamGrabberGetStreamGrabber () const
 Returns the pylon stream grabber interface pointer.
 
Implementation of the IStreamGrabber interface

See Pylon::IStreamGrabber for more details.

void Open ()
 Opens the stream grabber. More...
 
void Close ()
 Closes the stream grabber. More...
 
bool IsOpen () const
 Retrieve whether the stream grabber is open. More...
 
StreamBufferHandle RegisterBuffer (void *Buffer, size_t BufferSize)
 Registers a buffer for subsequent use. More...
 
const void * DeregisterBuffer (StreamBufferHandle handle)
 Deregisters the buffer. More...
 
void PrepareGrab ()
 Prepares grabbing. More...
 
void FinishGrab ()
 Stops grabbing. More...
 
void QueueBuffer (StreamBufferHandle Handle, const void *Context=NULL)
 Enqueues a buffer in the input queue. More...
 
void CancelGrab ()
 Cancels pending requests. More...
 
bool RetrieveResult (GrabResult &Result)
 Retrieves a grab result from the output queue. More...
 
WaitObjectGetWaitObject () const
 Returns the result event object. More...
 
GenApi::INodeMap * GetNodeMap ()
 Returns the associated stream grabber parameters. More...
 
Some smart pointer functionality
virtual void Attach (GenApi::INodeMap *, bool replace=false)
 Attach a pylon node map.
 
virtual GenApi::INodeMap * GetNodeMap () 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
 
GenApi::INode * GetNode (const GenICam::gcstring &Name) const
 
void InvalidateNodes () const
 
void Poll (int64_t ElapsedTime)
 

Detailed Description

template<class TParams>
class Pylon::CStreamGrabberProxyT< TParams >

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

This is the base class for pylon stream 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::CStreamGrabberProxyT< TParams >::CancelGrab ( void  )
inline

Cancels pending requests.

, resources remain allocated. Following, the results must be retrieved from the Output Queue.

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

Closes the stream grabber.

Flushes the result queue and stops the thread.

template<class TParams>
const void* Pylon::CStreamGrabberProxyT< TParams >::DeregisterBuffer ( StreamBufferHandle  handle)
inline

Deregisters the buffer.

Deregistering fails while the buffer is in use, so retrieve the buffer from the output queue after grabbing.

Note
Do not delete buffers before they are deregistered.
template<class TParams>
void Pylon::CStreamGrabberProxyT< TParams >::FinishGrab ( void  )
inline

Stops grabbing.

Releases the resources and camera. Pending grab requests are canceled.

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

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

Returns the associated stream grabber parameters.

If no parameters are available, NULL is returned.

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

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

Returns the result event object.

This object is associated with the result queue. The event is signaled when queue is non-empty

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

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

Retrieve whether the stream grabber is open.

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

Opens the stream grabber.

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

template<class TParams>
void Pylon::CStreamGrabberProxyT< TParams >::PrepareGrab ( void  )
inline

Prepares grabbing.

Allocates resources, synchronizes with the camera and locks critical parameter

template<class TParams>
void Pylon::CStreamGrabberProxyT< TParams >::QueueBuffer ( StreamBufferHandle  Handle,
const void *  Context = NULL 
)
inline

Enqueues a buffer in the input queue.

PrepareGrab is required to queue buffers. The context is returned together with the buffer and the grab result. It is not touched by the stream grabber. It is illegal to queue a buffer a second time before it is fetched from the result queue.

template<class TParams>
StreamBufferHandle Pylon::CStreamGrabberProxyT< TParams >::RegisterBuffer ( void *  Buffer,
size_t  BufferSize 
)
inline

Registers a buffer for subsequent use.

Stream must be locked to register buffers The Buffer size may not exceed the value specified when PrepareGrab was called.

template<class TParams>
bool Pylon::CStreamGrabberProxyT< TParams >::RetrieveResult ( GrabResult Result)
inline

Retrieves a grab result from the output queue.

Returns
When result was available true is returned and and the first result is copied into the grabresult. Otherwise the grabresult remains unchanged and false is returned.

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

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