CXXR::GCRootBase Class Reference

Untemplated base class for GCRoot. More...

#include <GCRoot.h>

Inheritance diagram for CXXR::GCRootBase:

List of all members.

Static Public Member Functions
static void	visitRoots (GCNode::const_visitor *v)
	Conduct a const visitor to all 'root' GCNode objects.

Protected Member Functions
	GCRootBase (const GCNode *node)
	Primary constructor.
	GCRootBase (const GCRootBase &source)
	Copy constructor.
GCRootBase &	operator= (const GCRootBase &source)
void	redirect (const GCNode *node)
	Change the node protected by this GCRootBase.
const GCNode *	ptr () const
	Access the encapsulated pointer.

Friends
class	GCNode

---

Detailed Description

Untemplated base class for GCRoot.

The preferred method for C++ code to protect a GCNode from the garbage collector is to use the templated class GCRoot, of which this is the untemplated base class, or class GCStackRoot.

---

Constructor & Destructor Documentation

CXXR::GCRootBase::GCRootBase ( const GCNode *  node )

protected

Primary constructor.

Parameters:

node	Pointer, possibly null, to the node to be protected.

CXXR::GCRootBase::GCRootBase ( const GCRootBase &  source )

inlineprotected

Copy constructor.

Parameters:

source

Pattern for the copy.

---

Member Function Documentation

const GCNode* CXXR::GCRootBase::ptr ( ) const

inlineprotected

Access the encapsulated pointer.

Returns:

the GCNode pointer encapsulated by this object.

void CXXR::GCRootBase::redirect ( const GCNode *  node )

inlineprotected

Change the node protected by this GCRootBase.

Parameters:

node	Pointer to the node now to be protected, or a null pointer.

static void CXXR::GCRootBase::visitRoots ( GCNode::const_visitor *  v )

static

Conduct a const visitor to all 'root' GCNode objects.

Conduct a GCNode::const_visitor object to each root GCNode and each node on the C pointer protection stack.

Parameters:

v	Pointer to the const_visitor object.

---

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

• GCRoot.h ($Id: GCRoot.h 1353 2013-03-18 16:59:38Z arr $)