Developer Documentation
Centre for Vision, Speech & Signal Processing
USER IN NAMESPACE AMMA TREE ROOT AMMA SEARCH AMMA HOME
 

  PUBLIC
BRCPtrC::BRCPtrC(void)
BRCPtrC::BRCPtrC(T *)
BRCPtrC::BRCPtrC(T &)
BRCPtrC::BRCPtrC(const BRCPtrC &)
BRCPtrC::~BRCPtrC(void)
BRCPtrC::IsValidObject(void) const
BRCPtrC::operator=(T *)
BRCPtrC::operator=(T &)
BRCPtrC::operator=(const BRCPtrC &)
BRCPtrC::operator->(void)
BRCPtrC::operator->(void) const
BRCPtrC::operator T *(void)
BRCPtrC::operator const T *(void) const
BRCPtrC::operator*(void)
BRCPtrC::operator*(void) const
BRCPtrC::GetPtr(void)
BRCPtrC::GetPtr(void) const
BRCPtrC::operator==(const T *) const
BRCPtrC::operator==(const BRCPtrC &) const
BRCPtrC::operator!=(const T *) const
BRCPtrC::operator!=(const BRCPtrC &) const
BRCPtrC::IsNull(void) const
BRCPtrC::Hash(void) const
BRCPtrC::SetPtr(T *)
BRCPtrC::Swap(BRCPtrC &)
BRCPtrC<class T>
 
Class BRCPtrC is a smart pointer.
 
include "amma/BRefCntPtr.hh"
User Level:Default
Library:MRefC
Example:exBRefC.cc
Section:Basic Types.Refrence Counting
In Scope:std

Comments:
The pointed target class must be derived from BodyRefCounterC.

Variables:
T * To;
The pointer to the referenced object.

Methods:
BRCPtrC()
Default constructor. Creates a NULL ptr.

BRCPtrC(T * nObj)
Constructs from a ptr.

BRCPtrC(T & nObj)
Constructs from a refrence.

BRCPtrC(const BRCPtrC<T> & nObj)

~BRCPtrC()
Destructor.

BooleanT IsValidObject() const
Test if object is valid. A NULL ptr WILL cause an error. When amma check is disabled this always returns true.

T * operator=(T * nPtr)
Assign to a ptr.

T & operator=(T & nPtr)
Assign to an object.

const BRCPtrC & operator=(const BRCPtrC<T> & It)
Assign to value of another BRCPtrC<>. Access functions ----------------

T * operator->()
Access members

const T * operator->() const
Access members

operator T *()
Cast to ptr.

operator const T *() const
Cast to ptr.

T & operator*()
De-refrence.

const T & operator*() const
De-refrence.

T * GetPtr(void)
Explicitly get a ptr.

const T * GetPtr(void) const
Explicitly get a ptr. Logical operators -----------------

BooleanT operator==(const T * nPtr) const
Equal to a ptr ?

BooleanT operator==(const BRCPtrC<T> & Oth) const
Equal to another BRCPtrC ?

BooleanT operator!=(const T * nPtr) const
Non-Equal to a ptr ?

BooleanT operator!=(const BRCPtrC<T> & Oth) const
Non-Equal to another BRCPtrC ?

BooleanT IsNull(void) const
Is ptr NULL ?

UIntT Hash() const
Hash on address of object, this assumes the objects are 32-bit aligned Modifications -------------

T * SetPtr(T * Newun)
Set value of ptr.

void Swap(BRCPtrC<T> & ptr)
Exchanges the content of this pointer and pointer 'ptr'.


Programmer:Charles Galambos, Documentation by CxxDoc: Tue Mar 20 10:49:27 2001