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 *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... | |
WaitObject & | GetWaitObject () 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) |
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 |
Cancels pending requests.
, resources remain allocated. Following, the results must be retrieved from the Output Queue.
|
inline |
Closes the stream grabber.
Flushes the result queue and stops the thread.
|
inline |
Deregisters the buffer.
Deregistering fails while the buffer is in use, so retrieve the buffer from the output queue after grabbing.
|
inline |
Stops grabbing.
Releases the resources and camera. Pending grab requests are canceled.
|
inlineinherited |
|
inline |
Returns the associated stream grabber parameters.
If no parameters are available, NULL is returned.
|
inlineinherited |
|
inline |
Returns the result event object.
This object is associated with the result queue. The event is signaled when queue is non-empty
|
inlineinherited |
|
inline |
Retrieve whether the stream grabber is open.
|
inline |
Opens the stream grabber.
|
inlineinherited |
|
inline |
Prepares grabbing.
Allocates resources, synchronizes with the camera and locks critical parameter
|
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.
|
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.
|
inline |
Retrieves a grab result from the output queue.