Class: TAllocationHeap

Declaration: AllocationHeap.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

None.

Inherited By:

None.

Purpose:

TAllocationHeap is a class that provides a default heap allocation policy. TAllocationHeap is intended to be used as the default heap and combines good performance with a simple and easy-to-use interface.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Do not derive any classes from TAllocationHeap.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAllocationHeap::TAllocationHeap

TAllocationHeap (const void * anObject)
TAllocationHeap (TMemoryHeap * aHeap)
TAllocationHeap (const TAllocationHeap & that)

Interface Category:

API.

Purpose:

Creates a TAllocationHeap on the same heap as anObject. If anObject cannot be found, the default heap is used.
Creates a TAllocationHeap to represent aHeap. If aHeap is NIL, the default is used.
Copy constructor.

Calling Context:

Called to create a TAllocationHeap to represent the heap.
Called to create a TAllocationHeap on the specified heap.
Called to copy an object.

Parameters:

const void * anObject -The object whose heap is to be used for this TAllocationHeap.
TMemoryHeap * aHeap -The heap to be represented by this object.
const TAllocationHeap & that -The object to be copied.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAllocationHeap::~TAllocationHeap

~ TAllocationHeap ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAllocationHeap::operator=

TAllocationHeap & operator =(const TAllocationHeap & that)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TAllocationHeap & that -The object to be copied.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAllocationHeap::operator->

TMemoryHeap * operator ->() const

Interface Category:

API.

Purpose:

Allows this object to be used as a TMemoryHeap pointer.

Calling Context:

Called whenever this object is referenced as a TAllocationHeap.

Parameters:

Takes no parameters.

Return Value:

A reference to this heap.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TAllocationHeap::operatorTMemoryHeap*

operator TMemoryHeap * () const

Interface Category:

API.

Purpose:

Allows a TAllocationHeap to be referenced as a TMemoryHeap.

Calling Context:

Called automatically whenever this object is referenced as a TMemoryHeap.

Parameters:

Takes no parameters.

Return Value:

A reference to this heap.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.