A smart pointer holding a reference to grab result data. More...
#include <pylon/GrabResultPtr.h>
Public Member Functions | |
CGrabResultPtr () | |
Creates a smart pointer. More... | |
CGrabResultPtr (const CGrabResultPtr &rhs) | |
Creates a copy of a smart pointer. More... | |
CGrabResultPtr & | operator= (const CGrabResultPtr &rhs) |
Assignment of a smart pointer. More... | |
~CGrabResultPtr () | |
Destroys the smart pointer. More... | |
CGrabResultData * | operator-> () const |
Allows accessing the referenced data. More... | |
bool | IsValid () const |
Check whether data is referenced. More... | |
operator bool () const | |
Check whether data is referenced. More... | |
void | Release () |
The currently referenced data is released. More... | |
operator IImage & () const | |
Provides an IImage interface to the grab result. More... | |
bool | IsUnique () const |
Indicates that the held grab result data and buffer is only referenced by this grab result. More... | |
A smart pointer holding a reference to grab result data.
This class is used for distributing the grab result data of a camera. It controls the reuse and lifetime of the referenced buffer. When all smart pointers referencing a buffer go out of scope the referenced buffer is reused or destroyed. The data and the held buffer are still valid after the camera object it originated from has been destroyed.
The CGrabResultPtr class provides a cast operator that allows passing the grab result directly to functions or methods that take an const IImage& as parameter, e.g. image saving functions or image format converter methods.
Pylon::CGrabResultPtr::CGrabResultPtr | ( | ) |
Creates a smart pointer.
Pylon::CGrabResultPtr::CGrabResultPtr | ( | const CGrabResultPtr & | rhs | ) |
Creates a copy of a smart pointer.
[in] | rhs | Another smart pointer, source of the result data to reference. |
The data itself is not copied.
Pylon::CGrabResultPtr::~CGrabResultPtr | ( | ) |
Destroys the smart pointer.
bool Pylon::CGrabResultPtr::IsUnique | ( | ) | const |
Indicates that the held grab result data and buffer is only referenced by this grab result.
bool Pylon::CGrabResultPtr::IsValid | ( | ) | const |
Check whether data is referenced.
Pylon::CGrabResultPtr::operator bool | ( | ) | const |
Check whether data is referenced.
The overloaded bool operator can be used to check whether data is referenced. Example:
Pylon::CGrabResultPtr::operator IImage & | ( | ) | const |
Provides an IImage interface to the grab result.
This cast operator allows passing the grab result to saving functions or image format converter. The returned image is invalid if the grab was not successful, see CGrabResultData::GrabSucceeded().
CGrabResultData* Pylon::CGrabResultPtr::operator-> | ( | ) | const |
Allows accessing the referenced data.
CGrabResultPtr& Pylon::CGrabResultPtr::operator= | ( | const CGrabResultPtr & | rhs | ) |
Assignment of a smart pointer.
[in] | rhs | Another smart pointer, source of the result data to reference. |
The data itself is not copied.
void Pylon::CGrabResultPtr::Release | ( | ) |
The currently referenced data is released.