Spinnaker C++
2.6.0.0
Public Member Functions | List of all members
ImagePtr Class Reference

A reference tracked pointer to an image object. More...

Inheritance diagram for ImagePtr:
BasePtr< IImage >

Public Member Functions

 ImagePtr ()
 Default constructor. More...
 
 ImagePtr (const int)
 Default constructor with argument. More...
 
 ImagePtr (const long)
 Default constructor with argument. More...
 
 ImagePtr (const std::nullptr_t)
 Default constructor with argument. More...
 
virtual ~ImagePtr (void)
 Virtual destructor. More...
 
virtual ImagePtroperator= (const ImagePtr &)
 Assignment operator. More...
 
- Public Member Functions inherited from BasePtr< IImage >
 BasePtr (void) throw ()
 Default constructor. More...
 
 BasePtr (const BasePtr &other) throw ()
 Copy constructor. More...
 
virtual ~BasePtr (void)
 
virtual BasePtroperator= (const BasePtr &rhs)
 Assign INode Pointer. More...
 
virtual BasePtroperator= (const int nMustBeNull)
 
virtual BasePtroperator= (const long nMustBeNull)
 
virtual BasePtroperator= (const std::nullptr_t nullPtr)
 
virtual operator IImage * (void) const
 Dereferencing. More...
 
virtual IImageoperator-> (void) const
 Dereferencing. More...
 
virtual bool IsValid () const throw ()
 True if the pointer is valid. More...
 
virtual operator bool (void) const throw ()
 True if the pointer is valid. More...
 
virtual bool operator== (const BasePtr &rT) const
 Pointer equal. More...
 
virtual bool operator== (std::nullptr_t) const
 Pointer equal. More...
 
virtual bool operator== (int nMustBeNull) const
 Pointer equal. More...
 
virtual bool operator== (long nMustBeNull) const
 Pointer equal. More...
 
virtual IImageget () const
 get() More...
 

Additional Inherited Members

- Protected Attributes inherited from BasePtr< IImage >
PointerData * m_pT
 Underlying raw pointer. More...
 

Detailed Description

A reference tracked pointer to an image object.

When the ImagePtr goes out of scope, it will trigger an auto release of the image from the stream.

Examples:
Acquisition.cpp, AcquisitionMultipleCameraRecovery.cpp, AcquisitionMultipleThread.cpp, ActionCommand.cpp, BufferHandling.cpp, ChunkData.cpp, Compression.cpp, CounterAndTimer.cpp, DeviceEvents.cpp, Exposure.cpp, Exposure_QuickSpin.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageEvents.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, LookupTable.cpp, Polarization.cpp, SaveToAvi.cpp, Sequencer.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

Constructor & Destructor Documentation

ImagePtr ( )

Default constructor.

ImagePtr ( const int  )

Default constructor with argument.

ImagePtr ( const long  )

Default constructor with argument.

ImagePtr ( const std::nullptr_t  )

Default constructor with argument.

virtual ~ImagePtr ( void  )
virtual

Virtual destructor.

Member Function Documentation

virtual ImagePtr& operator= ( const ImagePtr )
virtual

Assignment operator.


The documentation for this class was generated from the following file:
Contact Support Spinnaker® SDK Programmer's Guide and API Reference