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

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

#include <pylon/usb/PylonUsbCamera.h>

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

Public Member Functions

Construction
 CPylonUsbStreamGrabber ()
 Creates a CStreamGrabberProxyT object that is not attached to a pylon stream grabber. Use the Attach() method to attach the pylon stream grabber. More...
 
 CPylonUsbStreamGrabber (IStreamGrabber *pStreamGrabber)
 Creates a CStreamGrabberProxyT object and attaches it to a pylon stream grabber. More...
 
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.
 
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.
 
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...
 
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)
 

Public Attributes

Root - Interface to the USB-specific stream parameters.
GenApi::IInteger & MaxNumBuffer
 The maximum number of buffers that can be used simultaneously. More...
 
GenApi::IInteger & MaxBufferSize
 The maximum buffer size in bytes that can be registered. More...
 
GenApi::IInteger & MaxTransferSize
 Controls the maximum size of USB transfers. More...
 
GenApi::IInteger & NumMaxQueuedUrbs
 The maximum number of requests to be enqueued to the driver. More...
 
GenApi::IInteger & TransferLoopThreadPriority
 The priority of the thread that handles USB requests of the stream interface. More...
 
GenApi::IInteger & TransferTimeout
 Timeout in ms for payload and trailer transfers. More...
 
Statistic - Statistical data.
GenApi::IInteger & Statistic_Total_Buffer_Count
 The total count of processed buffers. More...
 
GenApi::IInteger & Statistic_Failed_Buffer_Count
 The count of buffers that returned with an error status. More...
 
GenApi::IInteger & Statistic_Last_Failed_Buffer_Status
 The status code of the last failed buffer. More...
 
GenApi::IString & Statistic_Last_Failed_Buffer_Status_Text
 The message text of the status code of the last failed buffer. More...
 
GenApi::IInteger & Statistic_Missed_Frame_Count
 The count of bad or missed frames between successfully grabbed images. More...
 
GenApi::IInteger & Statistic_Resynchronization_Count
 The count of stream resynchronizations. More...
 
GenApi::IInteger & Statistic_Last_Block_Id
 The last grabbed block ID. More...
 

Detailed Description

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

See Also
Accessing Parameters

Constructor & Destructor Documentation

Pylon::CPylonUsbStreamGrabber::CPylonUsbStreamGrabber ( )
inline

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

Pylon::CPylonUsbStreamGrabber::CPylonUsbStreamGrabber ( IStreamGrabber pStreamGrabber)
inline

Creates a CStreamGrabberProxyT object and attaches it to a pylon stream grabber.

Member Function Documentation

void Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::CancelGrab ( void  )
inlineinherited

Cancels pending requests.

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

Closes the stream grabber.

Flushes the result queue and stops the thread.

const void* Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::DeregisterBuffer ( StreamBufferHandle  handle)
inlineinherited

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.
void Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::FinishGrab ( void  )
inlineinherited

Stops grabbing.

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

GenApi::INode* Pylon::CNodeMapProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::GetNode ( const GenICam::gcstring Name) const
inlineinherited

GenApi::INodeMap* Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::GetNodeMap ( void  )
inlineinherited

Returns the associated stream grabber parameters.

If no parameters are available, NULL is returned.

WaitObject& Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::GetWaitObject ( void  ) const
inlineinherited

Returns the result event object.

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

void Pylon::CNodeMapProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::InvalidateNodes ( ) const
inlineinherited

bool Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::IsOpen ( void  ) const
inlineinherited

Retrieve whether the stream grabber is open.

Opens the stream grabber.

void Pylon::CNodeMapProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::Poll ( int64_t  ElapsedTime)
inlineinherited

void Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::PrepareGrab ( void  )
inlineinherited

Prepares grabbing.

Allocates resources, synchronizes with the camera and locks critical parameter

void Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::QueueBuffer ( StreamBufferHandle  Handle,
const void *  Context = NULL 
)
inlineinherited

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.

StreamBufferHandle Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::RegisterBuffer ( void *  Buffer,
size_t  BufferSize 
)
inlineinherited

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.

bool Pylon::CStreamGrabberProxyT< Basler_UsbStreamParams::CUsbStreamParams_Params >::RetrieveResult ( GrabResult Result)
inlineinherited

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.

Member Data Documentation

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::MaxBufferSize
inherited

The maximum buffer size in bytes that can be registered.

Visibility = Expert

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::MaxNumBuffer
inherited

The maximum number of buffers that can be used simultaneously.

Visibility = Expert

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::MaxTransferSize
inherited

Controls the maximum size of USB transfers.

The default value is appropriate for most applications. Reducing the value may cause a higher CPU load. USB host adapter drivers may require to decrease the value in case the application fails to receive the image stream. The maximum value for the Maximum Transfer Size depends on the operating system version and may be limited by the host adapter drivers.

Visibility = Guru

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::NumMaxQueuedUrbs
inherited

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

Visibility = Guru

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::Statistic_Failed_Buffer_Count
inherited

The count of buffers that returned with an error status.

Visibility = Expert

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::Statistic_Last_Block_Id
inherited

The last grabbed block ID.

Visibility = Expert

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::Statistic_Last_Failed_Buffer_Status
inherited

The status code of the last failed buffer.

Visibility = Expert

GenApi::IString& Basler_UsbStreamParams::CUsbStreamParams_Params::Statistic_Last_Failed_Buffer_Status_Text
inherited

The message text of the status code of the last failed buffer.

Visibility = Expert

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::Statistic_Missed_Frame_Count
inherited

The count of bad or missed frames between successfully grabbed images.

Visibility = Expert

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::Statistic_Resynchronization_Count
inherited

The count of stream resynchronizations.

Visibility = Expert

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::Statistic_Total_Buffer_Count
inherited

The total count of processed buffers.

Visibility = Expert

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::TransferLoopThreadPriority
inherited

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

Visibility = Guru

GenApi::IInteger& Basler_UsbStreamParams::CUsbStreamParams_Params::TransferTimeout
inherited

Timeout in ms for payload and trailer transfers.

Timeout in ms for payload and trailer transfers.

\b Visibility = Invisible

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