GENAPI_NAMESPACE::CPointer< T, B > Class Template Reference

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

#include <Pointer.h>

Public Member Functions
	CPointer (B *pB)
	Constructor from INode pointer type. More...
	CPointer (void) throw ()
	Default constructor. More...
bool	IsValid () const throw ()
	true if the pointer is valid More...
	operator bool (void) const throw ()
	true if the pointer is valid 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...
CPointer &	operator= (B *pB)
	Assign INode Pointer. More...
bool	operator== (const CPointer< T, B > &rT) const
	pointer equal More...
bool	operator== (int nMustBeNull) const
	pointer equal More...
bool	operator== (T *pT) const
	pointer equal More...
virtual	~CPointer (void)

Protected Attributes
T *	m_pT
	Underlying raw pointer. More...

Detailed Description

template<class T, class B = IBase>
class GENAPI_NAMESPACE::CPointer< T, B >

Encapsulates a GenApi pointer dealing with the dynamic_cast automatically.

Definition at line 51 of file Pointer.h.

Constructor & Destructor Documentation

CPointer() [1/2]

template<class T , class B = IBase>

GENAPI_NAMESPACE::CPointer< T, B >::CPointer ( void  ) throw ( )

inline

Default constructor.

Definition at line 56 of file Pointer.h.

CPointer() [2/2]

template<class T , class B = IBase>

GENAPI_NAMESPACE::CPointer< T, B >::CPointer ( B *  pB )

inline

Constructor from INode pointer type.

Definition at line 62 of file Pointer.h.

~CPointer()

template<class T , class B = IBase>

virtual GENAPI_NAMESPACE::CPointer< T, B >::~CPointer ( void  )

inlinevirtual

Definition at line 67 of file Pointer.h.

Member Function Documentation

IsValid()

template<class T , class B = IBase>

bool GENAPI_NAMESPACE::CPointer< T, B >::IsValid ( ) const throw ( )

inline

true if the pointer is valid

Definition at line 111 of file Pointer.h.

operator bool()

template<class T , class B = IBase>

GENAPI_NAMESPACE::CPointer< T, B >::operator bool ( void  ) const throw ( )

inline

true if the pointer is valid

Definition at line 117 of file Pointer.h.

operator T*()

template<class T , class B = IBase>

GENAPI_NAMESPACE::CPointer< T, B >::operator T* ( void  ) const

inline

Dereferencing.

Definition at line 79 of file Pointer.h.

operator()()

template<class T , class B = IBase>

T& GENAPI_NAMESPACE::CPointer< T, B >::operator() ( void  ) const

inline

Dereferencing.

Definition at line 95 of file Pointer.h.

operator*()

template<class T , class B = IBase>

T& GENAPI_NAMESPACE::CPointer< T, B >::operator* ( void  ) const

inline

Dereferencing.

Definition at line 87 of file Pointer.h.

operator->()

template<class T , class B = IBase>

T* GENAPI_NAMESPACE::CPointer< T, B >::operator-> ( void  ) const

inline

Dereferencing.

Definition at line 103 of file Pointer.h.

operator=()

template<class T , class B = IBase>

CPointer& GENAPI_NAMESPACE::CPointer< T, B >::operator= ( B *  pB )

inline

Assign INode Pointer.

Definition at line 72 of file Pointer.h.

operator==() [1/3]

template<class T , class B = IBase>

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

inline

pointer equal

Definition at line 129 of file Pointer.h.

operator==() [2/3]

template<class T , class B = IBase>

bool GENAPI_NAMESPACE::CPointer< T, B >::operator== ( int  nMustBeNull ) const

inline

pointer equal

Definition at line 135 of file Pointer.h.

operator==() [3/3]

template<class T , class B = IBase>

bool GENAPI_NAMESPACE::CPointer< T, B >::operator== ( T *  pT ) const

inline

pointer equal

Definition at line 123 of file Pointer.h.

Member Data Documentation

m_pT

template<class T , class B = IBase>

T* GENAPI_NAMESPACE::CPointer< T, B >::m_pT

protected

Underlying raw pointer.

Definition at line 146 of file Pointer.h.

---

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

• Pointer.h