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 (void) throw ()
	Default constructor. More...
	CPointer (B *pB)
	Constructor from INode pointer type. 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...
void	operator= (B *pB)
	Assign INode Pointer. 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...
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

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.

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.

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

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 110 of file Pointer.h.

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 116 of file Pointer.h.

template<class T, class B = IBase>

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

inline

Dereferencing.

Definition at line 78 of file Pointer.h.

template<class T, class B = IBase>

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

inline

Dereferencing.

Definition at line 94 of file Pointer.h.

template<class T, class B = IBase>

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

inline

Dereferencing.

Definition at line 86 of file Pointer.h.

template<class T, class B = IBase>

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

inline

Dereferencing.

Definition at line 102 of file Pointer.h.

template<class T, class B = IBase>

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

inline

Assign INode Pointer.

Definition at line 72 of file Pointer.h.

template<class T, class B = IBase>

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

inline

pointer equal

Definition at line 122 of file Pointer.h.

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 128 of file Pointer.h.

template<class T, class B = IBase>

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

inline

pointer equal

Definition at line 134 of file Pointer.h.

Member Data Documentation

template<class T, class B = IBase>

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

protected

Underlying raw pointer.

Definition at line 145 of file Pointer.h.

---

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

• Pointer.h