Spinnaker SDK C++
4.3.0.189
 
Public Member Functions | Protected Attributes | List of all members
CPointer< T, B > Class Template Reference

Encapsulates a GenApi pointer dealing with the dynamic_cast automatically. More...

Public Member Functions

 CPointer (void)
 Default constructor. More...
 
 CPointer (B *pB)
 Constructor from INode pointer type. More...
 
virtual ~CPointer (void)
 
void operator= (B *pB)
 Assign INode Pointer. More...
 
 operator T* (void) const
 Dereferencing. More...
 
T & operator* (void) const
 Dereferencing. More...
 
T & operator() (void) const
 Dereferencing. More...
 
T * operator-> (void) const
 Dereferencing. More...
 
bool IsValid () const throw ()
 true if the pointer is valid More...
 
 operator bool (void) const throw ()
 true if the pointer is valid More...
 
bool operator== (T *pT) const
 pointer equal More...
 
bool operator== (const CPointer< T, B > &rT) const
 pointer equal More...
 
bool operator== (int nMustBeNull) const
 pointer equal More...
 
bool operator!= (const CPointer< T, B > &rT) const
 pointer inequal More...
 
bool operator!= (T *pT) const
 pointer inequal More...
 
bool operator!= (const long int nMustBeNull) const
 pointer inequal More...
 
bool operator!= (const int nMustBeNull) const
 pointer inequal More...
 
bool operator!= (const std::nullptr_t nullPtr) const
 pointer inequal More...
 

Protected Attributes

T * m_pT
 Underlying raw pointer. More...
 

Detailed Description

template<class T, class B = IBase>
class Spinnaker::GenApi::CPointer< T, B >

Encapsulates a GenApi pointer dealing with the dynamic_cast automatically.

Examples
Acquisition.cpp, AcquisitionMultipleCameraRecovery.cpp, AcquisitionMultipleCamerasWriteToFile.cpp, AcquisitionMultipleThread.cpp, AcquisitionUserBuffer.cpp, BufferHandling.cpp, Compression.cpp, Exposure.cpp, FileAccess_Quickspin.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, NodeMapCallback.cpp, NodeMapInfo.cpp, NodeMapInfo_QuickSpin.cpp, Polarization.cpp, SaveToVideo.cpp, StereoAcquisition.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

Constructor & Destructor Documentation

◆ CPointer() [1/2]

CPointer ( void  )
inline

Default constructor.

◆ CPointer() [2/2]

CPointer ( B *  pB)
inline

Constructor from INode pointer type.

◆ ~CPointer()

virtual ~CPointer ( void  )
inlinevirtual

Member Function Documentation

◆ IsValid()

bool IsValid ( ) const
throw (
)
inline

true if the pointer is valid

Examples
AcquisitionMultipleCameraRecovery.cpp.

◆ operator bool()

operator bool ( void  ) const
throw (
)
inline

true if the pointer is valid

◆ operator T*()

operator T* ( void  ) const
inline

Dereferencing.

◆ operator!=() [1/5]

bool operator!= ( const CPointer< T, B > &  rT) const
inline

pointer inequal

◆ operator!=() [2/5]

bool operator!= ( const int  nMustBeNull) const
inline

pointer inequal

◆ operator!=() [3/5]

bool operator!= ( const long int  nMustBeNull) const
inline

pointer inequal

◆ operator!=() [4/5]

bool operator!= ( const std::nullptr_t  nullPtr) const
inline

pointer inequal

◆ operator!=() [5/5]

bool operator!= ( T *  pT) const
inline

pointer inequal

◆ operator()()

T& operator() ( void  ) const
inline

Dereferencing.

◆ operator*()

T& operator* ( void  ) const
inline

Dereferencing.

◆ operator->()

T* operator-> ( void  ) const
inline

Dereferencing.

◆ operator=()

void operator= ( B *  pB)
inline

Assign INode Pointer.

◆ operator==() [1/3]

bool operator== ( const CPointer< T, B > &  rT) const
inline

pointer equal

◆ operator==() [2/3]

bool operator== ( int  nMustBeNull) const
inline

pointer equal

◆ operator==() [3/3]

bool operator== ( T *  pT) const
inline

pointer equal

Member Data Documentation

◆ m_pT

T* m_pT
protected

Underlying raw pointer.


The documentation for this class was generated from the following file: