TFixedArray in Base Kernel_Architecture

class TFixedArray;

Description

A thin wrapper class for C++ arrays allowing automatic checking of index values to ensure that all accesses are legal.

The class also supports the deletion of objects.

The class is templated, based on a class type and an integer value. The class type defines the type of object contained in the array; the integer value defines the size (dimension) of the array.

A wrapper object can be:

1. embedded in objects allocated on the heap.

2. used on the program stack.

Members

Defined in TFixedArray:

Array()constCreates and returns a generic array for this C++ array.
At(TInt)Gets a reference to the specified element within the C++ array.
At(TInt)constGets a const reference to the specified element within the C++ array.
AtFunctionR(const CBase *,TInt)
Begin()Gets a pointer to the first element of the array.
Begin()constGets a pointer to the first element of the array.
Copy(const T *,TInt)Copies the specified set of contiguous objects into the C++ array.
Count()constGets the size of the array.
CountFunctionR(const CBase *)
DeleteAll()Invokes the delete operator on every member of the array.
End()Gets a pointer to the first byte following the end of the array.
End()constGets a pointer to the first byte following the end of the array.
InRange(TInt)
Length()constGets the size of an array element, in bytes.
Reset()Fills every element of the array with binary zeroes.
TFixedArray()Default constructor.
TFixedArray(const T *,TInt)Constructs a C++ array initialised with the specified objects.
iRep
operator[](TInt)Gets a reference to the specified element within the C++ array.
operator[](TInt)constGets a const reference to the specified element within the C++ array.

inline TFixedArray();

Description

Default constructor.

Constructs an uninitialised C++ array.

inline TFixedArray(const T *aList, TInt aLength);

Description

Constructs a C++ array initialised with the specified objects.

Parameters

`const T *aList`	A pointer to a set of contiguous objects.
`TInt aLength`	The number of contiguous objects to be copied. This value must not be negative and must not be greater than the size of the array as defined by the integer template parameter.

Panic codes

USER

133, in a debug build only, if aLength is negative or is greater than the size of the array as defined by the integer template parameter.

inline void Copy(const T *aList, TInt aLength);

Description

Copies the specified set of contiguous objects into the C++ array.

The copy operation starts at the beginning of the array, replacing any existing data.

Parameters

`const T *aList`	A pointer to a set of contiguous objects.
`TInt aLength`	The number of contiguous objects to be copied. This value must not be negative and must not be greater than the size of the array as defined by the integer template parameter.

Panic codes

USER

133, in a debug build only, if aLength is negative or is greater than the size of the array as defined by the integer template parameter.

inline void Reset();

Description

Fills every element of the array with binary zeroes.

inline void DeleteAll();

Description

Invokes the delete operator on every member of the array.

The function can only be used for arrays of pointers to CBase derived objects.

If the array is to be used after a call to this function, it is good practice to call TFixedArray::Reset() to set all array elements to NULL.

inline TInt Count() const;

Description

Gets the size of the array.

For any instance of this class, the array size is fixed and has the same value as the integer template parameter.

Return value


                                 						TInt

The size of the array.

inline TInt Length() const;

Description

Gets the size of an array element, in bytes.

Return value


                                 						TInt

The size of an array element, in bytes.

inline T& operator[](TInt aIndex);

Description

Gets a reference to the specified element within the C++ array.

Parameters


                                 						TInt aIndex

The position of the element within the array. This is an offset value; a zero value refers to the first element in the array. This value must be greater than or equal to zero and less than the size of the array.

Return value

T &

A reference to an element of the array.

Panic codes

USER

133, in a debug build only, if aIndex is negative or greater than or equal to the size of the array as defined by the integer template parameter.

inline const T& operator[](TInt aIndex) const;

Description

Gets a const reference to the specified element within the C++ array.

Parameters


                                 						TInt aIndex

The position of the element within the array. This is an offset value; a zero value refers to the first element in the array. This value must be greater than or equal to zero and less than the size of the array.

Return value

const T &

A const reference to an element of the array; the element cannot be changed through this reference.

Panic codes

USER

133, in a debug build only, if aIndex is negative or greater than or equal to the size of the array as defined by the integer template parameter.

inline T& At(TInt aIndex);

Description

Gets a reference to the specified element within the C++ array.

Parameters


                                 						TInt aIndex

The position of the element within the array. This is an offset value; a zero value refers to the first element in the array. This value must be greater than or equal to zero and less than the size of the array.

Return value

T &

A reference to an element of the array.

Panic codes

USER

133, if aIndex is negative or greater than or equal to the size of the array as defined by the integer template parameter.

inline const T& At(TInt aIndex) const;

Description

Gets a const reference to the specified element within the C++ array.

Parameters


                                 						TInt aIndex

The position of the element within the array. This is an offset value; a zero value refers to the first element in the array. This value must be greater than or equal to zero and less than the size of the array.

Return value

const T &

Parameters


                                 						TInt aIndex

Return value


                                 						TBool

protected: static inline TInt CountFunctionR(const CBase *aThis);

Description

Parameters

const CBase *aThis

Return value


                                 						TInt

protected: static inline const TAny* AtFunctionR(const CBase *aThis, TInt aIndex);

Description

Parameters

`const CBase *aThis`
`TInt aIndex`

Return value

const TAny *

protected: T iRep[S];

Class TFixedArray

Description

Members

Construction and destruction

TFixedArray()

Description

TFixedArray(const T *,TInt)

Description

Parameters

Panic codes

Member functions

Copy(const T *,TInt)

Description

Parameters

Panic codes

Reset()

Description

DeleteAll()

Description

Count()const

Description

Return value

Length()const

Description

Return value

operator[](TInt)

Description

Parameters

Return value

Panic codes

operator[](TInt)const

Description

Parameters

Return value

Panic codes

At(TInt)

Description

Parameters

Return value

Panic codes

At(TInt)const

Description

Parameters

Return value

Panic codes

Begin()

Description

Return value

End()

Description

Return value

Begin()const

Description

Return value

End()const

Description

Return value

Array()const

Description

Return value

InRange(TInt)

Description

Parameters

Return value

CountFunctionR(const CBase *)

Description

Parameters

Return value

AtFunctionR(const CBase *,TInt)

Description

Parameters

Return value

Member data

iRep

Description

Class `TFixedArray`

`TFixedArray()`

`TFixedArray(const T *,TInt)`

`Copy(const T *,TInt)`

`Reset()`

`DeleteAll()`

`Count()const`

`Length()const`

`operator[](TInt)`

`operator[](TInt)const`

`At(TInt)`

`At(TInt)const`

`Begin()`

`End()`

`Begin()const`

`End()const`

`Array()const`

`InRange(TInt)`

`CountFunctionR(const CBase *)`

`AtFunctionR(const CBase *,TInt)`

`iRep`