Spinnaker C++
2.6.0.0
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, AcquisitionMultipleThread.cpp, ActionCommand.cpp, BufferHandling.cpp, ChunkData.cpp, Compression.cpp, CounterAndTimer.cpp, DeviceEvents.cpp, Enumeration.cpp, EnumerationEvents.cpp, Exposure.cpp, Exposure_QuickSpin.cpp, FileAccess_Quickspin.cpp, GigEVisionPerformance.cpp, ImageEvents.cpp, ImageFormatControl.cpp, ImageFormatControl_QuickSpin.cpp, Inference.cpp, LogicBlock.cpp, LookupTable.cpp, NodeMapCallback.cpp, NodeMapInfo.cpp, Polarization.cpp, SaveToAvi.cpp, Sequencer.cpp, SerialRxTx.cpp, Trigger.cpp, and Trigger_QuickSpin.cpp.

Constructor & Destructor Documentation

CPointer ( void  )
inline

Default constructor.

CPointer ( B *  pB)
inline

Constructor from INode pointer type.

virtual ~CPointer ( void  )
inlinevirtual

Member Function Documentation

bool IsValid ( ) const
throw (
)
inline

true if the pointer is valid

Examples:
AcquisitionMultipleCameraRecovery.cpp.
operator bool ( void  ) const
throw (
)
inline

true if the pointer is valid

operator T * ( void  ) const
inline

Dereferencing.

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

pointer inequal

bool operator!= ( T *  pT) const
inline

pointer inequal

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

pointer inequal

bool operator!= ( const int  nMustBeNull) const
inline

pointer inequal

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

pointer inequal

T& operator() ( void  ) const
inline

Dereferencing.

T& operator* ( void  ) const
inline

Dereferencing.

T* operator-> ( void  ) const
inline

Dereferencing.

void operator= ( B *  pB)
inline

Assign INode Pointer.

bool operator== ( T *  pT) const
inline

pointer equal

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

pointer equal

bool operator== ( int  nMustBeNull) const
inline

pointer equal

Member Data Documentation

T* m_pT
protected

Underlying raw pointer.


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