![]() |
![]() |
Low Level API: The stream grabber class with parameter access methods. More...
#include <pylon/StreamGrabberProxy.h>
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 IStreamGrabber * | GetStreamGrabber () 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 *pBuffer, size_t bufferSize) |
Registers a buffer for subsequent use. More... | |
const void * | DeregisterBuffer (StreamBufferHandle hStreamBuffer) |
Deregisters the buffer. More... | |
void | PrepareGrab () |
Prepares grabbing. More... | |
bool | IsStartAndStopStreamingMandatory () |
Returns true if the Stream Grabber requires calling StartStreamingIfMandatory() for operation. More... | |
void | StartStreamingIfMandatory () |
Starts streaming for the stream grabber if this is mandatory for operation. More... | |
void | StopStreamingIfMandatory () |
Stops streaming for the stream grabber if this is mandatory for operation. More... | |
void | FinishGrab () |
Stops grabbing finally. More... | |
void | QueueBuffer (StreamBufferHandle hStreamBuffer, const void *pContext=NULL) |
Enqueues a buffer in the input queue. More... | |
void | FlushBuffersToOutput () |
Cancels grabbing the current buffer and flushes all buffers to the output queue. More... | |
void | CancelGrab () |
bool | RetrieveResult (GrabResult &Result) |
Retrieves one grab result from the output queue. More... | |
WaitObject & | GetWaitObject () const |
Returns the result event object of the stream grabber. 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 |
Retrieves all nodes in the node map. More... | |
GenApi::INode * | GetNode (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... | |
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.
TParams | The specific parameter class (auto generated from the parameter xml file) |
|
inline |
Closes the stream grabber.
This method calls FinishGrab() automatically if needed.
|
inline |
Deregisters the buffer.
[in] | hStreamBuffer | The handle of a buffer that has been provided by RegisterBuffer() |
|
inline |
Stops grabbing finally.
This method calls FlushBuffersToOutput() automatically if needed.
|
inline |
Cancels grabbing the current buffer and flushes all buffers to the output queue.
|
inlineinherited |
Retrieves the node from the central map by Name.
|
inline |
Returns the associated stream grabber parameters.
|
inlineinherited |
Retrieves all nodes in the node map.
|
inline |
Returns the result event object of the stream grabber.
This object is associated with the output queue of the stream grabber. The event is signaled when output queue is non-empty.
|
inlineinherited |
Invalidates all nodes.
|
inline |
Retrieve whether the stream grabber is open.
|
inline |
Returns true if the Stream Grabber requires calling StartStreamingIfMandatory() for operation.
|
inline |
Opens the stream grabber.
|
inlineinherited |
Fires nodes which have a polling time.
|
inline |
Prepares grabbing.
The node map integer parameters MaxBufferSize and MaxNumBuffer need to be set before calling PrepareGrab().
MaxNumBuffer should be set to the number of buffers you plan to use for grabbing.
MaxBufferSize needs to be set according to the PayloadSize parameter of the camera device or the stream grabber. If the stream grabber provides a PayloadSize parameter, the MaxBufferSize must be at least the size reported by the stream grabber payload size. This is the case if for instance a frame grabber or additional preprocessing is used. If the stream grabber does not provide a PayloadSize parameter, the MaxBufferSize must be at least the size reported by the camera device PayloadSize parameter.
|
inline |
Enqueues a buffer in the input queue.
[in] | hStreamBuffer | The handle of a buffer that has been provided by RegisterBuffer(). |
[in] | pContext | A user-provided pointer passed along with buffer in the internal input and output queues. |
|
inline |
Registers a buffer for subsequent use.
[in] | pBuffer | The pointer of the buffer that is to be used for grabbing e.g., for grabbing images. |
[in] | bufferSize | The size of the provided buffer in bytes. |
|
inline |
Retrieves one grab result from the output queue.
param[out] grabResult The object the grab result data is returned in if true is returned. The grabResult
remains unchanged if false is returned.
|
inline |
Starts streaming for the stream grabber if this is mandatory for operation.
Some stream grabbers e.g., some stream grabbers based on GenTL, have limitations on when buffers can be registered. For these stream grabbers it is mandatory to register all buffers first and call StartStreamingIfMandatory() aftwards. Between the StartStreamingIfMandatory() and StopStreamingIfMandatory() calls no buffers can be registered or deregistered if such a limitation exists.
|
inline |
Stops streaming for the stream grabber if this is mandatory for operation.
Some stream grabbers e.g., some stream grabbers based on GenTL, have limitations on when buffers can be registered. For these stream grabbers it is mandatory to call StopStreamingIfMandatory to be able to deregister buffer afterwards.