Main Page | Namespace List | Class Hierarchy | Alphabetical List | Compound List | File List | Compound Members | File Members

Arena Class Reference

A Virtual Base Class for Dynamic Memory Managemen. More...

#include <Arena.H>

Inheritance diagram for Arena:

Inheritance graph
[legend]
List of all members.

Public Types

typedef void(* FP )()

Public Member Functions

 Arena ()
 base class constructor

virtual ~Arena ()
 base class destructor.

virtual void * alloc (size_t sz)=0
virtual void free (void *pt)=0

Static Public Member Functions

size_t align (size_t sz)

Detailed Description

A Virtual Base Class for Dynamic Memory Managemen.

A Virtual Base Class for Dynamic Memory Management

This is a virtual base class for objects that manage their own dynamic memory allocation. Since it is a virtual base class, you have to derive something from it to use it.


Member Typedef Documentation

typedef void(* Arena::FP)()
 


Constructor & Destructor Documentation

Arena::Arena  ) 
 

base class constructor

base class constructor. registers Arena object with memory tracking system

virtual Arena::~Arena  )  [virtual]
 

base class destructor.

base class destructor. unregisters Arena object with memory tracking system


Member Function Documentation

size_t Arena::align size_t  sz  )  [inline, static]
 

: Given a minimum required arena size of sz bytes, this returns the next largest arena size that will hold an integral number of objects of the largest of the types void*, long, double and function pointer.

virtual void* Arena::alloc size_t  sz  )  [pure virtual]
 

: Allocate a dynamic memory arena of size sz. A pointer to this memory should be returned.

Implemented in BArena, and CArena.

virtual void Arena::free void *  pt  )  [pure virtual]
 

: A pure virtual function for deleting the arena pointed to by pt.

Implemented in BArena, and CArena.


The documentation for this class was generated from the following file:
Generated on Wed Jun 2 13:58:13 2004 for Chombo&INSwithParticles by doxygen 1.3.2