Class CArrayFix< TAny >

class CArrayFix< TAny > : public CArrayFixBase;

Description

A template specialisation base class for arrays of fixed length untyped objects.

The public functions provide standard array behaviour.

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

Derivation

• CBase - Base class for all classes to be instantiated on the heap.

• CArrayFixBase - Base class for arrays of fixed length objects.

• CArrayFix< TAny > - A template specialisation base class for arrays of fixed length untyped objects.

Members

Defined in CArrayFix< TAny >:

• AppendL(const TAny *)Appends the specified untyped element onto the end of the array.
• AppendL(const TAny *,TInt)Appends one or more untyped elements onto the end of the array.
• At(TInt)Gets a pointer to the untyped element located at the specified position within t...
• At(TInt)constGets a pointer to the untyped element located at the specified position within t...
• Back(TInt)Gets a pointer to the beginning of a contiguous region.
• Back(TInt)constGets a pointer to the beginning of a contiguous region.
• End(TInt)Gets a pointer to the first byte following the end of the contiguous region cont...
• End(TInt)constGets a pointer to the first byte following the end of the contiguous region cont...
• ExtendL()Expands the array by the length of one element at the end of the array and retur...

Inherited from CArrayFixBase:

• Compress()Compresses the array.
• Count()constGets the number of elements held in the array.
• Delete(TInt)Deletes a single element from the array at a specified position.
• Delete(TInt,TInt)Deletes one or more contiguous elements from the array, starting at a specific p...
• Length()constGets the length of an element.
• Reset()Deletes all elements from the array and frees the memory allocated to the array ...
• Sort(TKeyArrayFix &)Sorts the elements of the array into key sequence.

Inherited from CBase:

• Delete(CBase *)Deletes the specified object.
• Extension_(TUint,TAny *&,TAny *)Extension function
• operator new(TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TAny *)Initialises the object to binary zeroes.
• operator new(TUint,TLeave)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TLeave,TUint)Allocates the object from the heap and then initialises its contents to binary z...
• operator new(TUint,TUint)Allocates the object from the heap and then initialises its contents to binary z...

inline const TAny* At(TInt anIndex) const;

Description

Gets a pointer to the untyped element located at the specified position within the array.

Parameters

TInt anIndex The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return value

const TAny * A pointer to the untyped element located at position anIndex within the array.

Panic codes

E32User-CBase 21, if anIndex is negative or is greater than or equal to the number of objects currently within the array.

inline const TAny* End(TInt anIndex) const;

Description

Gets a pointer to the first byte following the end of the contiguous region containing the element at the specfied position within the array.

For flat buffers, the pointer always points to the first byte following the end of the buffer.

For segmented buffers, the pointer always points to the first byte following the end of the segment which contains the element.

Parameters

TInt anIndex The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return value

const TAny * A pointer to the byte following the end of the contiguous region.

Panic codes

E32USER-CBase 21, if anIndex is negative or greater than or equal to the number of objects currently within the array.

inline const TAny* Back(TInt anIndex) const;

Description

Gets a pointer to the beginning of a contiguous region.

For flat buffers, the function always returns a pointer to the beginning of the buffer.

For segmented buffers, the function returns a pointer to the beginning of the segment for all elements in that segment except the first. If the element at the specified position is the first in a segment, then the function returns a pointer the beginning of the previous segment.

For the first element in the array, the function returns a NULL pointer.

Parameters

TInt anIndex The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return value

const TAny * A pointer to the beginning of the contiguous region.

Panic codes

E32User-CBase 21, if anIndex is negative or is greater than or equal to the number of objects currently within the array.

inline TAny* At(TInt anIndex);

Description

Gets a pointer to the untyped element located at the specified position within the array.

Parameters

TInt anIndex The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return value

TAny * A pointer to the untyped element located at position anIndex within the array.

Panic codes

E32User-CBase 21, if anIndex is negative or is greater than or equal to the number of objects currently within the array.

inline TAny* End(TInt anIndex);

Description

Gets a pointer to the first byte following the end of the contiguous region containing the element at the specfied position within the array.

For flat buffers, the pointer always points to the first byte following the end of the buffer.

For segmented buffers, the pointer always points to the first byte following the end of the segment which contains the element.

Parameters

TInt anIndex The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return value

TAny * A pointer to the byte following the end of the contiguous region.

Panic codes

E32USER-CBase 21, if anIndex is negative or greater than or equal to the number of objects currently within the array.

inline TAny* Back(TInt anIndex);

Description

Gets a pointer to the beginning of a contiguous region.

For flat buffers, the function always returns a pointer to the beginning of the buffer.

For segmented buffers, the function returns a pointer to the beginning of the segment for all elements in that segment except the first. If the element at the specified position is the first in a segment, then the function returns a pointer the beginning of the previous segment.

For the first element in the array, the function returns a NULL pointer.

Parameters

TInt anIndex The position of the element within the array. The position is relative to zero; i.e. zero implies the first element in the array.

Return value

TAny * A pointer to the beginning of the contiguous region.

Panic codes

E32User-CBase 21, if anIndex is negative or is greater than or equal to the number of objects currently within the array.

inline void AppendL(const TAny *aPtr);

Description

Appends the specified untyped element onto the end of the array.

Parameters

const TAny *aPtr A pointer to an untyped element to be appended.

Leave codes

KErrNoMemory The function may attempt to expand the array buffer. If there is insufficient memory available, the function leaves, in which case the array is left in the state it was in before the call.

inline void AppendL(const TAny *aPtr, TInt aCount);

Description

Appends one or more untyped elements onto the end of the array.

Parameters

const TAny *aPtr A pointer to the first of the contiguous untyped elements to be appended. TInt aCount The number of contiguous elements located at aPtr to be appended.

Leave codes

KErrNoMemory The function may attempt to expand the array buffer. If there is insufficient memory available, the function leaves, in which case the array is left in the state it was in before the call.

Panic codes

E32USER-CBase 23, if aCount is negative.

inline TAny* ExtendL();

Description

Expands the array by the length of one element at the end of the array and returns a pointer to this new location.

As elements are untyped, no construction is possible and the content of the new location remains undefined.

Return value

TAny * A pointer to the new element location at the end of the array.

Leave codes

KErrNoMemory The function may attempt to expand the array buffer. If there is insufficient memory available, the function leaves, in which case the array is left in the state it was in before the call.