Class CArrayFixBase

CArrayFixBase

Support

Supported from 5.0

Description

Base class for arrays of fixed length objects. It provides implementation and public functions which are common to all arrays of this type.

The class is always derived from and is never instantiated explicitly.

Derivation

CArrayFixBase Base class for arrays of fixed length objects CBase Base class for all classes to be instantiated on the heap

Defined in CArrayFixBase:
Compress(), Count(), Delete(), Length(), Reset(), Sort(), ~CArrayFixBase()

Inherited from CBase:
operator new()

~CArrayFixBase();

Description

Destructor. This frees all resources owned by the object, prior to its destruction.

TInt Count() const;

Description

Returns the number of elements held in the array.

Return value

TInt The number of array elements

TInt Length() const;

Description

Returns the length of an element.

Return value

TInt The length of an element of type <class T>.

void Reset();

Description

Resets the array.

Thsi function deletes all elements from the array and frees the memory allocated to the array buffer.

void Compress();

Description

Compresses the array.

This function removes the excess space from the array buffer. The effect is to reduce the memory allocated to the array buffer so that it is just sufficient to contain the elements of the array. This applies to both flat and segmented array buffers.

If the array is empty, then the memory allocated to the array buffer is freed.

TInt Sort(TKeyArrayFix& aKey);

Description

Sorts the elements of the array into key sequence.

Parameters

TKeyArrayFix& aKey The key object defining the properties of the key.

Return value

TInt KErrNone if the sort completes successfully, KErrGeneral if the stack overflows

void Delete(TInt anIndex);
void Delete(TInt anIndex,TInt aCount);

Description

Delete elements by position.

This function removes one or more contiguous elements from the array, starting at a specific position within the array.

Deleting elements from the array does not cause the array buffer to be automatically compressed. Call CArrayFixBase::Compress() to return excess space to the heap.

Note:

The sum of anIndex and aCount must not be greater than the number of elements currently in the array, otherwise the functions raise an E32USER-CBase 29 panic.

Parameters

TInt anIndex The position within the array from where deletion of elements is to start. The position is relative to zero, i.e. zero implies that elements, starting with the first, are deleted from the array. This value must not be negative and must not be greater than the number of elements currently in the array, otherwise the function raises an E32USER-CBase 21 panic. TInt aCount If specified, the number of contiguous elements to be deleted from the array. If this is not specified, a value of one is assumed. If specified, the value must not be negative otherwise the function raises an E32USER-CBase 22 panic.