BasicDynamicClassNodeBase Class Reference

#include <BasicDynamicClassNodeBase.h>

Inheritance diagram for BasicDynamicClassNodeBase:

Inheritance graph
[legend]
Collaboration diagram for BasicDynamicClassNodeBase:

Collaboration graph
[legend]

List of all members.

Public Member Functions

 BasicDynamicClassNodeBase ()
virtual unsigned int getSize () const =0
virtual void _init (void *x)=0
void * getNode (const void *x) const
void registerNode (BasicDynamicClassFactory *factory)

Protected Member Functions

void setOffset (const unsigned int offset)
virtual ~BasicDynamicClassNodeBase ()

Protected Attributes

BasicDynamicClassFactoryfactory
unsigned int offset

Friends

class BasicDynamicClassFactory


Detailed Description

BasicDynamicClassNodeBase is a generic node of a BasicDynamicClass. See BasicDynamicClassFactory.

If you don't understand this class don't use it!

Definition at line 37 of file BasicDynamicClassNodeBase.h.


Constructor & Destructor Documentation

BasicDynamicClassNodeBase::BasicDynamicClassNodeBase (  )  [inline]

Definition at line 43 of file BasicDynamicClassNodeBase.h.

virtual BasicDynamicClassNodeBase::~BasicDynamicClassNodeBase (  )  [inline, protected, virtual]

Definition at line 82 of file BasicDynamicClassNodeBase.h.


Member Function Documentation

virtual unsigned int BasicDynamicClassNodeBase::getSize (  )  const [pure virtual]

virtual void BasicDynamicClassNodeBase::_init ( void *  x  )  [pure virtual]

void * BasicDynamicClassNodeBase::getNode ( const void *  x  )  const

This function should not be used directly because it is not type safe.

Parameters:
x The dynamic class.
Returns:
A pointer to the memory allocated for this class node.

Definition at line 30 of file BasicDynamicClassNodeBase.cpp.

References ASSERT_OR_THROW, factory, and offset.

Referenced by BasicDynamicClassNode< CompuCell3D::CellTypeNode >::get().

void BasicDynamicClassNodeBase::registerNode ( BasicDynamicClassFactory factory  ) 

Register this node with the factory. If this node has already been registered with some factory a BasicException will be thrown.

Parameters:
factory The factory with which to register.

Definition at line 38 of file BasicDynamicClassNodeBase.cpp.

References ASSERT_OR_THROW, and BasicDynamicClassFactory::registerNode().

void BasicDynamicClassNodeBase::setOffset ( const unsigned int  offset  )  [inline, protected]

Called by BasicDynamicClassFactory to set the offset in the dynamic class to this class node.

Parameters:
offset The byte offset.

Definition at line 80 of file BasicDynamicClassNodeBase.h.

Referenced by BasicDynamicClassFactory::registerNode().


Friends And Related Function Documentation

friend class BasicDynamicClassFactory [friend]

Definition at line 84 of file BasicDynamicClassNodeBase.h.


Member Data Documentation

Definition at line 39 of file BasicDynamicClassNodeBase.h.

Referenced by getNode().

unsigned int BasicDynamicClassNodeBase::offset [protected]

Definition at line 40 of file BasicDynamicClassNodeBase.h.

Referenced by getNode().


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

Generated on Thu Dec 4 11:41:19 2008 for CompuCell3D by  doxygen 1.5.6