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

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...
 
CGrabResultPtroperator= (const CGrabResultPtr &rhs)
 Assignment of a smart pointer. More...
 
 ~CGrabResultPtr ()
 Destroys the smart pointer. More...
 
CGrabResultDataoperator-> () 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...
 

Detailed Description

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.

Attention
The grabbing will stop with an input queue underrun, when the grab results are never released, e.g. when put into a container.

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.

Attention
The returned reference to IImage is only valid as long the CGrabResultPtr object it came from is not destroyed.
Thread Safety: Instances of CGrabResultPtr referencing the same grab result can be used from any thread context.

Constructor & Destructor Documentation

Pylon::CGrabResultPtr::CGrabResultPtr ( )

Creates a smart pointer.

Postcondition
No grab result is referenced.
Pylon::CGrabResultPtr::CGrabResultPtr ( const CGrabResultPtr rhs)

Creates a copy of a smart pointer.

Parameters
[in]rhsAnother smart pointer, source of the result data to reference.

The data itself is not copied.

Postcondition
  • Another reference to the grab result of the source is held if it references a grab result.
  • No grab result is referenced if the source does not reference a grab result.
Error Safety:
Still valid after error.
Pylon::CGrabResultPtr::~CGrabResultPtr ( )

Destroys the smart pointer.

Postcondition
The currently referenced data is released.
Error Safety:
Does not throw C++ exceptions.

Member Function Documentation

bool Pylon::CGrabResultPtr::IsUnique ( ) const

Indicates that the held grab result data and buffer is only referenced by this grab result.

Returns
Returns true if the held grab result data and buffer is only referenced by this grab result. Returns false if the grab result is invalid.
Error Safety:
Does not throw C++ exceptions.
bool Pylon::CGrabResultPtr::IsValid ( ) const

Check whether data is referenced.

Returns
True if data is referenced.
Error Safety:
Does not throw C++ exceptions.
Pylon::CGrabResultPtr::operator bool ( ) const

Check whether data is referenced.

Returns
IsValid().

The overloaded bool operator can be used to check whether data is referenced. Example:

if ( grabResult)
{
grabResult->GetStatus();
}
Error Safety:
Does not throw C++ exceptions.
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().

Attention
The returned reference is only valid as long the grab result ptr is not destroyed.
Error Safety:
Still valid after error.
CGrabResultData* Pylon::CGrabResultPtr::operator-> ( ) const

Allows accessing the referenced data.

Returns
The pointer to the grab result data.
Precondition
The pointer must reference a grab result. IsValid() or the overloaded bool operator can be used to check whether data is referenced.
Error Safety:
Still valid after error. Throws an exception when no data is referenced.
CGrabResultPtr& Pylon::CGrabResultPtr::operator= ( const CGrabResultPtr rhs)

Assignment of a smart pointer.

Parameters
[in]rhsAnother smart pointer, source of the result data to reference.

The data itself is not copied.

Postcondition
  • The currently referenced data is released.
  • Another reference to the grab result of the source is held if it references a grab result.
  • No grab result is referenced if the source does not reference a grab result.
Error Safety:
Still valid after error.
void Pylon::CGrabResultPtr::Release ( )

The currently referenced data is released.

Postcondition
The currently referenced data is released.
Error Safety:
Still valid after error.

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)