Symbian^3 Application Developer Library >

RPointerArray Class Reference

class RPointerArray : private RPointerArrayBase

A simple and efficient array of pointers to objects.

The elements of the array are pointers to instances of a class; this class is specified as the template parameter T.

The class offers standard array behaviour which includes insertion, appending and sorting of pointers.

Derivation from RPointerArrayBase is private.

Inherits from

Public Member Functions
RPointerArray ()
RPointerArray ( TInt )
RPointerArray ( TInt , TInt )
RPointerArray ( T **, TInt )
TInt Append (const T *)
void AppendL (const T *)
TArray < T * > Array ()
void Close ()
void Compress ()
TInt Count ()
TInt Find (const T *)
TInt Find (const T *, TIdentityRelation < T >)
TInt Find (const K &, TBool (*)(const K *k, const T &t))
TInt FindInAddressOrder (const T *)
TInt FindInAddressOrder (const T *, TInt &)
TInt FindInAddressOrderL (const T *)
void FindInAddressOrderL (const T *, TInt &)
TInt FindInOrder (const T *, TLinearOrder < T >)
TInt FindInOrder (const T *, TInt &, TLinearOrder < T >)
TInt FindInOrder (const K &, TInt (*)(const K *k, const T &t))
TInt FindInOrderL (const T *, TLinearOrder < T >)
void FindInOrderL (const T *, TInt &, TLinearOrder < T >)
TInt FindL (const T *)
TInt FindL (const T *, TIdentityRelation < T >)
TInt FindReverse (const T *)
TInt FindReverse (const T *, TIdentityRelation < T >)
TInt FindReverse (const K &, TInt (*)(const K *k, const T &t))
TInt FindReverseL (const T *)
TInt FindReverseL (const T *, TIdentityRelation < T >)
void GranularCompress ()
TInt Insert (const T *, TInt )
TInt InsertInAddressOrder (const T *)
TInt InsertInAddressOrderAllowRepeats (const T *)
void InsertInAddressOrderAllowRepeatsL (const T *)
void InsertInAddressOrderL (const T *)
TInt InsertInOrder (const T *, TLinearOrder < T >)
TInt InsertInOrderAllowRepeats (const T *, TLinearOrder < T >)
void InsertInOrderAllowRepeatsL (const T *, TLinearOrder < T >)
void InsertInOrderL (const T *, TLinearOrder < T >)
void InsertL (const T *, TInt )
void Remove ( TInt )
TInt Reserve ( TInt )
void ReserveL ( TInt )
void Reset ()
void ResetAndDestroy ()
void Sort ( TLinearOrder < T >)
void SortIntoAddressOrder ()
TInt SpecificFindInAddressOrder (const T *, TInt )
TInt SpecificFindInAddressOrder (const T *, TInt &, TInt )
TInt SpecificFindInAddressOrderL (const T *, TInt )
void SpecificFindInAddressOrderL (const T *, TInt &, TInt )
TInt SpecificFindInOrder (const T *, TLinearOrder < T >, TInt )
TInt SpecificFindInOrder (const T *, TInt &, TLinearOrder < T >, TInt )
TInt SpecificFindInOrderL (const T *, TLinearOrder < T >, TInt )
void SpecificFindInOrderL (const T *, TInt &, TLinearOrder < T >, TInt )
T *const & operator[] ( TInt )
T *& operator[] ( TInt )
Inherited Functions
RPointerArrayBase::Append(const TAny *)
RPointerArrayBase::At(TInt)const
RPointerArrayBase::BinarySearch(const TAny *,TInt &,TGeneralLinearOrder)const
RPointerArrayBase::BinarySearch(const TAny *,TInt &,TGeneralLinearOrder,TInt)const
RPointerArrayBase::BinarySearchSigned(TInt,TInt &)const
RPointerArrayBase::BinarySearchSigned(TInt,TInt &,TInt)const
RPointerArrayBase::BinarySearchUnsigned(TUint,TInt &)const
RPointerArrayBase::BinarySearchUnsigned(TUint,TInt &,TInt)const
RPointerArrayBase::DoReserve(TInt)
RPointerArrayBase::Entries()
RPointerArrayBase::Find(const TAny *)const
RPointerArrayBase::Find(const TAny *,TGeneralIdentityRelation)const
RPointerArrayBase::FindIsq(const TAny *,TGeneralLinearOrder)const
RPointerArrayBase::FindIsq(const TAny *,TGeneralLinearOrder,TInt)const
RPointerArrayBase::FindIsqSigned(TInt)const
RPointerArrayBase::FindIsqSigned(TInt,TInt)const
RPointerArrayBase::FindIsqUnsigned(TUint)const
RPointerArrayBase::FindIsqUnsigned(TUint,TInt)const
RPointerArrayBase::FindReverse(const TAny *)const
RPointerArrayBase::FindReverse(const TAny *,TGeneralIdentityRelation)const
RPointerArrayBase::GetCount(const CBase *)
RPointerArrayBase::GetElementPtr(const CBase *,TInt)
RPointerArrayBase::HeapSort(TGeneralLinearOrder)
RPointerArrayBase::HeapSortSigned()
RPointerArrayBase::HeapSortUnsigned()
RPointerArrayBase::Insert(const TAny *,TInt)
RPointerArrayBase::InsertIsq(const TAny *,TGeneralLinearOrder,TBool)
RPointerArrayBase::InsertIsqSigned(TInt,TBool)
RPointerArrayBase::InsertIsqUnsigned(TUint,TBool)
RPointerArrayBase::RPointerArrayBase()
RPointerArrayBase::RPointerArrayBase(TAny **,TInt)
RPointerArrayBase::RPointerArrayBase(TInt)
RPointerArrayBase::RPointerArrayBase(TInt,TInt)
RPointerArrayBase::ZeroCount()

Constructor & Destructor Documentation

RPointerArray()

RPointerArray ( ) [inline]

Default C++ constructor.

This constructs an array object for an array of pointers with default granularity, which is 8.

RPointerArray(TInt)

RPointerArray ( TInt aGranularity ) [inline, explicit]

C++ constructor with granularity.

This constructs an array object for an array of pointers with the specified granularity.

panic
USER 127, if aGranularity is not positive, or greater than or equal to 0x10000000.

Parameters

TInt aGranularity The granularity of the array.

RPointerArray(TInt, TInt)

RPointerArray ( TInt aMinGrowBy,
TInt aFactor
) [inline]

C++ constructor with minimum growth step and exponential growth factor.

This constructs an array object for an array of pointers with the specified minimum growth step and exponential growth factor.

panic
USER 192, if aMinGrowBy<=0 or aMinGrowBy>65535.
panic
USER 193, if aFactor<=257 or aFactor>32767.

Parameters

TInt aMinGrowBy The minimum growth step of the array. Must be between 1 and 65535 inclusive.
TInt aFactor The factor by which the array grows, multiplied by 256. For example 512 specifies a factor of 2. Must be between 257 and 32767 inclusive.

RPointerArray(T **, TInt)

RPointerArray ( T ** aEntries,
TInt aCount
) [inline]

C++ constructor with a pointer to the first array entry in a pre-existing array, and the number of entries in that array.

This constructor takes a pointer to a pre-existing set of entries of type pointer to class T, which is owned by another RPointerArray object. Ownership of the set of entries still resides with the original RPointerArray object.

panic
USER 156, if aCount is not positive.

Parameters

T ** aEntries A pointer to the first entry of type pointer to class T in the set of entries belonging to the existing array.
TInt aCount The number of entries in the existing array. The granularity of this array is set to this value.

Member Functions Documentation

Append(const T *)

TInt Append ( const T * anEntry ) [inline]

Appends an object pointer onto the array.

Parameters

const T * anEntry The object pointer to be appended.

AppendL(const T *)

void AppendL ( const T * anEntry ) [inline]

Appends an object pointer onto the array.

The function leaves with one of the system wide error codes, if the operation fails.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters

const T * anEntry The object pointer to be appended.

Array()

TArray < T * > Array ( ) const [inline]

Constructs and returns a generic array.

TArray

Close()

void Close ( ) [inline]

Closes the array and frees all memory allocated to it.

The function must be called before this array object goes out of scope.

Note that the function does not delete the objects whose pointers are contained in the array.

Compress()

void Compress ( ) [inline]

Compresses the array down to a minimum.

After a call to this function, the memory allocated to the array is just sufficient for its contained object pointers. Subsequently adding a new object pointer to the array always results in a re-allocation of memory.

Count()

TInt Count ( ) const [inline]

Gets the number of object pointers in the array.

Find(const T *)

TInt Find ( const T * anEntry ) const [inline]

Finds the first object pointer in the array which matches the specified object pointer, using a sequential search.

Matching is based on the comparison of pointers.

The find operation always starts at the low index end of the array. There is no assumption about the order of objects in the array.

Parameters

const T * anEntry The object pointer to be found.

Find(const T *, TIdentityRelation< T >)

TInt Find ( const T * anEntry,
TIdentityRelation < T > anIdentity
) const [inline]

Finds the first object pointer in the array whose object matches the specified object, using a sequential search and a matching algorithm.

The algorithm for determining whether two class T objects match is provided by a function supplied by the caller.

The find operation always starts at the low index end of the array. There is no assumption about the order of objects in the array.

Parameters

const T * anEntry The object pointer to be found.
TIdentityRelation < T > anIdentity A package encapsulating the function which determines whether two class T objects match.

Find(const K &, TBool(*)(const K *k, const T &t))

TInt Find ( const K & aKey,
TBool (*)(const K *k, const T &t) apfnCompare
) const [inline]

Finds the first object pointer in the array which matches aKey using the comparison algorithm provided by apfnCompare.

The find operation always starts at the low index end of the array. There is no assumption about the order of objects in the array.

Parameters

const K & aKey The key of type K to be compared with the elements of the array using apfnCompare.
TBool (*)(const K *k, const T &t) apfnCompare A function defining the identity relation between the object pointers in the array, and their keys of type K. The function returns true if k and t match based on this relationship.

FindInAddressOrder(const T *)

TInt FindInAddressOrder ( const T * anEntry ) const [inline]

Finds the object pointer in the array that matches the specified object pointer, using a binary search technique.

The function assumes that object pointers in the array are in address order.

Parameters

const T * anEntry The object pointer to be found.

FindInAddressOrder(const T *, TInt &)

TInt FindInAddressOrder ( const T * anEntry,
TInt & anIndex
) const [inline]

Finds the object pointer in the array that matches the specified object pointer, using a binary search technique.

The function assumes that object pointers in the array are in address order.

Parameters

const T * anEntry The object pointer to be found.
TInt & anIndex A TInt supplied by the caller. On return, contains an index value: If the function returns KErrNone, this is the index of the matching object pointer within the array. If the function returns KErrNotFound, this is the index of the first object pointer within the array which logically follows after anEntry.

FindInAddressOrderL(const T *)

TInt FindInAddressOrderL ( const T * anEntry ) const [inline]

Finds the object pointer in the array that matches the specified object pointer, using a binary search technique.

The function assumes that object pointers in the array are in address order.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no suitable object pointer can be found.

Parameters

const T * anEntry The object pointer to be found.

FindInAddressOrderL(const T *, TInt &)

void FindInAddressOrderL ( const T * anEntry,
TInt & anIndex
) const [inline]

Finds the object pointer in the array that matches the specified object pointer, using a binary search technique.

The function assumes that object pointers in the array are in address order.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no suitable object pointer can be found.

Parameters

const T * anEntry The object pointer to be found.
TInt & anIndex A reference to a TInt into which the function puts an index value: If the function does not leave, this is the index of the matching object pointer within the array. If the function leaves with KErrNotFound, this is the index of the first object pointer within the array which logically follows after anEntry.

FindInOrder(const T *, TLinearOrder< T >)

TInt FindInOrder ( const T * anEntry,
TLinearOrder < T > anOrder
) const [inline]

Finds the object pointer in the array whose object matches the specified object, using a binary search technique and an ordering algorithm.

The function assumes that existing object pointers in the array are ordered so that the objects themselves are in object order as determined by an algorithm supplied by the caller and packaged as a TLinearOrder<T>.

Parameters

const T * anEntry The object pointer to be found.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.

FindInOrder(const T *, TInt &, TLinearOrder< T >)

TInt FindInOrder ( const T * anEntry,
TInt & anIndex,
TLinearOrder < T > anOrder
) const [inline]

Finds the object pointer in the array whose object matches the specified object, using a binary search technique and an ordering algorithm.

The function assumes that existing object pointers in the array are ordered so that the objects themselves are in object order as determined by an algorithm supplied by the caller and packaged as a TLinearOrder<T>.

Parameters

const T * anEntry The object pointer to be found.
TInt & anIndex A TInt supplied by the caller. On return, contains an index value: If the function returns KErrNone, this is the index of the matching object pointer within the array. If the function returns KErrNotFound, this is the index of the first object pointer in the array whose object is larger than the entry being searched for - if no objects pointed to in the array are larger, then the index value is the same as the total number of object pointers in the array.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.

FindInOrder(const K &, TInt(*)(const K *k, const T &t))

TInt FindInOrder ( const K & aKey,
TInt (*)(const K *k, const T &t) apfnCompare
) const [inline]

Finds the object pointer in the array whose object matches the specified key, (Using the relationship defined within apfnCompare) using a binary search technique and an ordering algorithm.

The function assumes that existing object pointers in the array are ordered so that the objects themselves are in object order as determined by an algorithm supplied by the caller and packaged as a TLinearOrder<T>.

Parameters

const K & aKey The key of type K to be compared with the elements of the array using apfnCompare.
TInt (*)(const K *k, const T &t) apfnCompare A function which defines the order that the array was sorted, where in it aKey (via the defined relationship) should fit, and if the key is present.

FindInOrderL(const T *, TLinearOrder< T >)

TInt FindInOrderL ( const T * anEntry,
TLinearOrder < T > anOrder
) const [inline]

Finds the object pointer in the array whose object matches the specified object, using a binary search technique and an ordering algorithm.

The function assumes that existing object pointers in the array are ordered so that the objects themselves are in object order as determined by an algorithm supplied by the caller and packaged as a TLinearOrder<T>.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no suitable object pointer can be found.

Parameters

const T * anEntry The object pointer to be found.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.

FindInOrderL(const T *, TInt &, TLinearOrder< T >)

void FindInOrderL ( const T * anEntry,
TInt & anIndex,
TLinearOrder < T > anOrder
) const [inline]

Finds the object pointer in the array whose object matches the specified object, using a binary search technique and an ordering algorithm.

The function assumes that existing object pointers in the array are ordered so that the objects themselves are in object order as determined by an algorithm supplied by the caller and packaged as a TLinearOrder<T>.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no suitable object pointer can be found.

Parameters

const T * anEntry The object pointer to be found.
TInt & anIndex A TInt supplied by the caller. On return, contains an index value: If the function does not leave, this is the index of the matching object pointer within the array. If the function leaves with KErrNotFound, this is the index of the first object pointer in the array whose object is bigger than the entry being searched for - if no objects pointed to in the array are bigger, then the index value is the same as the total number of object pointers in the array.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.

FindL(const T *)

TInt FindL ( const T * anEntry ) const [inline]

Finds the first object pointer in the array which matches the specified object pointer, using a sequential search.

Matching is based on the comparison of pointers.

The find operation always starts at the low index end of the array. There is no assumption about the order of objects in the array.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no matching object pointer can be found.

Parameters

const T * anEntry The object pointer to be found.

FindL(const T *, TIdentityRelation< T >)

TInt FindL ( const T * anEntry,
TIdentityRelation < T > anIdentity
) const [inline]

Finds the first object pointer in the array whose object matches the specified object, using a sequential search and a matching algorithm.

The algorithm for determining whether two class T objects match is provided by a function supplied by the caller.

The find operation always starts at the low index end of the array. There is no assumption about the order of objects in the array.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no suitable object pointer can be found.

Parameters

const T * anEntry The object pointer to be found.
TIdentityRelation < T > anIdentity A package encapsulating the function which determines whether two class T objects match.

FindReverse(const T *)

TInt FindReverse ( const T * anEntry ) const [inline]

Finds the last object pointer in the array which matches the specified object pointer, using a sequential search.

Matching is based on the comparison of pointers.

The find operation always starts at the high index end of the array. There is no assumption about the order of objects in the array.

Parameters

const T * anEntry The object pointer to be found.

FindReverse(const T *, TIdentityRelation< T >)

TInt FindReverse ( const T * anEntry,
TIdentityRelation < T > anIdentity
) const [inline]

Finds the last object pointer in the array whose object matches the specified object, using a sequential search and a matching algorithm.

The algorithm for determining whether two class T objects match is provided by a function supplied by the caller.

The find operation always starts at the high index end of the array. There is no assumption about the order of objects in the array.

Parameters

const T * anEntry The object pointer to be found.
TIdentityRelation < T > anIdentity A package encapsulating the function which determines whether two class T objects match.

FindReverse(const K &, TInt(*)(const K *k, const T &t))

TInt FindReverse ( const K & aKey,
TInt (*)(const K *k, const T &t) apfnMatch
) const [inline]

Finds the first object pointer in the array which matches aKey using the comparison algorithm provided by apfnCompare.

The find operation always starts at the high index end of the array. There is no assumption about the order of objects in the array.

Parameters

const K & aKey The key of type K to be compared with the elements of the array using apfnMatch.
TInt (*)(const K *k, const T &t) apfnMatch A function defining the identity relation between the object pointers in the array, and their keys of type K. The function returns true if k and t match based on this relationship.

FindReverseL(const T *)

TInt FindReverseL ( const T * anEntry ) const [inline]

Finds the last object pointer in the array which matches the specified object pointer, using a sequential search.

Matching is based on the comparison of pointers.

The find operation always starts at the high index end of the array. There is no assumption about the order of objects in the array.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no matching object pointer can be found.

Parameters

const T * anEntry The object pointer to be found.

FindReverseL(const T *, TIdentityRelation< T >)

TInt FindReverseL ( const T * anEntry,
TIdentityRelation < T > anIdentity
) const [inline]

Finds the last object pointer in the array whose object matches the specified object, using a sequential search and a matching algorithm.

The algorithm for determining whether two class T objects match is provided by a function supplied by the caller.

The find operation always starts at the high index end of the array. There is no assumption about the order of objects in the array.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no suitable object pointer can be found.

Parameters

const T * anEntry The object pointer to be found.
TIdentityRelation < T > anIdentity A package encapsulating the function which determines whether two class T objects match.

GranularCompress()

void GranularCompress ( ) [inline]

Compresses the array down to a granular boundary.

After a call to this function, the memory allocated to the array is sufficient for its contained object pointers. Adding new object pointers to the array does not result in a re-allocation of memory until the the total number of pointers reaches a multiple of the granularity.

Insert(const T *, TInt)

TInt Insert ( const T * anEntry,
TInt aPos
) [inline]

Inserts an object pointer into the array at the specified position.

panic
USER 131, if aPos is negative, or is greater than the number of object pointers currently in the array.

Parameters

const T * anEntry The object pointer to be inserted.
TInt aPos The position within the array where the object pointer is to be inserted. The position is relative to zero, i.e. zero implies that a pointer is inserted at the beginning of the array.

InsertInAddressOrder(const T *)

TInt InsertInAddressOrder ( const T * anEntry ) [inline]

Inserts an object pointer into the array in address order.

No duplicate entries are permitted. The array remains unchanged following an attempt to insert a duplicate entry.

The function assumes that existing object pointers within the array are in address order.

Parameters

const T * anEntry The object pointer to be inserted.

InsertInAddressOrderAllowRepeats(const T *)

TInt InsertInAddressOrderAllowRepeats ( const T * anEntry ) [inline]

Inserts an object pointer into the array in address order, allowing duplicates.

If the new object pointer is a duplicate of an existing object pointer in the array, then the new pointer is inserted after the existing one. If more than one duplicate object pointer already exists in the array, then any new duplicate pointer is inserted after the last one.

The function assumes that existing object pointers within the array are in address order.

Parameters

const T * anEntry The object pointer to be inserted.

InsertInAddressOrderAllowRepeatsL(const T *)

void InsertInAddressOrderAllowRepeatsL ( const T * anEntry ) [inline]

Inserts an object pointer into the array in address order, allowing duplicates.

If the new object pointer is a duplicate of an existing object pointer in the array, then the new pointer is inserted after the existing one. If more than one duplicate object pointer already exists in the array, then any new duplicate pointer is inserted after the last one.

The function assumes that existing object pointers within the array are in address order.

The function leaves with one of the system wide error codes, if the operation fails.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters

const T * anEntry The object pointer to be inserted.

InsertInAddressOrderL(const T *)

void InsertInAddressOrderL ( const T * anEntry ) [inline]

Inserts an object pointer into the array in address order.

No duplicate entries are permitted. The function assumes that existing object pointers within the array are in address order.

The function leaves with one of the system wide error codes, if the operation fails.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters

const T * anEntry The object pointer to be inserted.

InsertInOrder(const T *, TLinearOrder< T >)

TInt InsertInOrder ( const T * anEntry,
TLinearOrder < T > anOrder
) [inline]

Inserts an object pointer into the array so that the object itself is in object order.

The algorithm for determining the order of two class T objects is provided by a function supplied by the caller.

No duplicate entries are permitted. The array remains unchanged following an attempt to insert a duplicate entry.

The function assumes that the array is ordered so that the referenced objects are in object order.

Parameters

const T * anEntry The object pointer to be inserted.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.

InsertInOrderAllowRepeats(const T *, TLinearOrder< T >)

TInt InsertInOrderAllowRepeats ( const T * anEntry,
TLinearOrder < T > anOrder
) [inline]

Inserts an object pointer into the array so that the object itself is in object order, allowing duplicates

The algorithm for determining the order of two class T objects is provided by a function supplied by the caller.

If the specified object is a duplicate of an existing object, then the new pointer is inserted after the pointer to the existing object. If more than one duplicate object already exists, then the new pointer is inserted after the pointer to the last one.

Parameters

const T * anEntry The object pointer to be inserted.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.

InsertInOrderAllowRepeatsL(const T *, TLinearOrder< T >)

void InsertInOrderAllowRepeatsL ( const T * anEntry,
TLinearOrder < T > anOrder
) [inline]

Inserts an object pointer into the array so that the object itself is in object order, allowing duplicates

The algorithm for determining the order of two class T objects is provided by a function supplied by the caller.

If the specified object is a duplicate of an existing object, then the new pointer is inserted after the pointer to the existing object. If more than one duplicate object already exists, then the new pointer is inserted after the pointer to the last one.

The function leaves with one of the system wide error codes, if the operation fails.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters

const T * anEntry The object pointer to be inserted.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.

InsertInOrderL(const T *, TLinearOrder< T >)

void InsertInOrderL ( const T * anEntry,
TLinearOrder < T > anOrder
) [inline]

Inserts an object pointer into the array so that the object itself is in object order.

The algorithm for determining the order of two class T objects is provided by a function supplied by the caller.

No duplicate entries are permitted.

The function assumes that the array is ordered so that the referenced objects are in object order.

The function leaves with one of the system wide error codes, if the operation fails.

Note that the array remains unchanged following an attempt to insert a duplicate entry.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

Parameters

const T * anEntry The object pointer to be inserted.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.

InsertL(const T *, TInt)

void InsertL ( const T * anEntry,
TInt aPos
) [inline]

Inserts an object pointer into the array at the specified position.

The function leaves with one of the system wide error codes, if the operation fails.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

panic
USER 131, if aPos is negative, or is greater than the number of object pointers currently in the array.

Parameters

const T * anEntry The object pointer to be inserted.
TInt aPos The position within the array where the object pointer is to be inserted. The position is relative to zero, i.e. zero implies that a pointer is inserted at the beginning of the array.

Remove(TInt)

void Remove ( TInt anIndex ) [inline]

Removes the object pointer at the specified position from the array.

Note that the function does not delete the object whose pointer is removed.

panic
USER 130, if anIndex is negative, or is greater than the number of objects currently in the array.

Parameters

TInt anIndex The position within the array from where the object pointer is to be removed. The position is relative to zero, i.e. zero implies that a pointer at the beginning of the array is to be removed.

Reserve(TInt)

TInt Reserve ( TInt aCount ) [inline]

Reserves space for the specified number of elements.

After a call to this function, the memory allocated to the array is sufficient to hold the number of object pointers specified. Adding new object pointers to the array does not result in a re-allocation of memory until the the total number of pointers exceeds the specified count.

Parameters

TInt aCount The number of object pointers for which space should be reserved

ReserveL(TInt)

void ReserveL ( TInt aCount ) [inline]

Reserves space for the specified number of elements.

After a call to this function, the memory allocated to the array is sufficient to hold the number of object pointers specified. Adding new object pointers to the array does not result in a re-allocation of memory until the the total number of pointers exceeds the specified count.

leave
KErrNoMemory If the requested amount of memory could not be allocated

Parameters

TInt aCount The number of object pointers for which space should be reserved

Reset()

void Reset ( ) [inline]

Empties the array.

It frees all memory allocated to the array and resets the internal state so that it is ready to be reused.

This array object can be allowed to go out of scope after a call to this function.

Note that the function does not delete the objects whose pointers are contained in the array.

ResetAndDestroy()

void ResetAndDestroy ( )

Empties the array and deletes the referenced objects.

It frees all memory allocated to the array and resets the internal state so that it is ready to be reused. The function also deletes all of the objects whose pointers are contained by the array.

This array object can be allowed to go out of scope after a call to this function.

Sort(TLinearOrder< T >)

void Sort ( TLinearOrder < T > anOrder ) [inline]

Sorts the object pointers within the array.

The sort order of the pointers is based on the order of the referenced objects. The referenced object order is determined by an algorithm supplied by the caller and packaged as a TLinerOrder<T>.

Parameters

TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.

SortIntoAddressOrder()

void SortIntoAddressOrder ( ) [inline]

Sorts the object pointers within the array into address order.

SpecificFindInAddressOrder(const T *, TInt)

TInt SpecificFindInAddressOrder ( const T * anEntry,
TInt aMode
) const [inline]

Finds the object pointer in the array that matches the specified object pointer, using a binary search technique.

Where there is more than one matching element, it finds the first, the last or any matching element as specified by the value of aMode.

The function assumes that object pointers in the array are in address order.

TArrayFindMode

Parameters

const T * anEntry The object pointer to be found.
TInt aMode Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

SpecificFindInAddressOrder(const T *, TInt &, TInt)

TInt SpecificFindInAddressOrder ( const T * anEntry,
TInt & anIndex,
TInt aMode
) const [inline]

Finds the object pointer in the array that matches the specified object pointer, using a binary search technique.

Where there is more than one matching element, it finds the first, the last or any matching element as specified by the value of aMode.

The function assumes that object pointers in the array are in address order.

TArrayFindMode

Parameters

const T * anEntry The object pointer to be found.
TInt & anIndex A TInt type supplied by the caller. On return, it contains an index value depending on whether a match is found and on the value of aMode. If there is no matching element in the array, then this is the index of the first element in the array that is bigger than the element being searched for - if no elements in the array are bigger, then the index value is the same as the total number of elements in the array. If there is a matching element, then what the index refers to depends on the value of aMode: if this is EArrayFindMode_First, then the index refers to the first matching element; if this is EArrayFindMode_Any, then the index can refer to any of the matching elements; if this is EArrayFindMode_Last, then the index refers to first element that follows the last matching element - if the last matching element is also the last element of the array, then the index value is the same as the total number of elements in the array.
TInt aMode Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

SpecificFindInAddressOrderL(const T *, TInt)

TInt SpecificFindInAddressOrderL ( const T * anEntry,
TInt aMode
) const [inline]

Finds the object pointer in the array that matches the specified object pointer, using a binary search technique.

Where there is more than one matching element, it finds the first, the last or any matching element as specified by the value of aMode.

The function assumes that object pointers in the array are in address order.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound if no matching entry exists.
TArrayFindMode

Parameters

const T * anEntry The object pointer to be found.
TInt aMode Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

SpecificFindInAddressOrderL(const T *, TInt &, TInt)

void SpecificFindInAddressOrderL ( const T * anEntry,
TInt & anIndex,
TInt aMode
) const [inline]

Finds the object pointer in the array that matches the specified object pointer, using a binary search technique.

Where there is more than one matching element, it finds the first, the last or any matching element as specified by the value of aMode.

The function assumes that object pointers in the array are in address order.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no suitable object pointer can be found.
TArrayFindMode

Parameters

const T * anEntry The object pointer to be found.
TInt & anIndex A TInt type supplied by the caller. On return, it contains an index value depending on whether a match is found and on the value of aMode. If there is no matching element in the array, then this is the index of the first element in the array that is bigger than the element being searched for - if no elements in the array are bigger, then the index value is the same as the total number of elements in the array. If there is a matching element, then what the index refers to depends on the value of aMode: if this is EArrayFindMode_First, then the index refers to the first matching element; if this is EArrayFindMode_Any, then the index can refer to any of the matching elements; if this is EArrayFindMode_Last, then the index refers to first element that follows the last matching element - if the last matching element is also the last element of the array, then the index value is the same as the total number of elements in the array.
TInt aMode Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

SpecificFindInOrder(const T *, TLinearOrder< T >, TInt)

TInt SpecificFindInOrder ( const T * anEntry,
TLinearOrder < T > anOrder,
TInt aMode
) const [inline]

Finds the object pointer in the array whose object matches the specified object, using a binary search technique and an ordering algorithm.

Where there is more than one matching element, it finds the first, the last or any matching element as specified by the value of aMode.

The function assumes that existing object pointers in the array are ordered so that the objects themselves are in object order as determined by an algorithm supplied by the caller and packaged as a TLinearOrder<T> type.

TArrayFindMode

Parameters

const T * anEntry The object pointer to be found.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.
TInt aMode Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

SpecificFindInOrder(const T *, TInt &, TLinearOrder< T >, TInt)

TInt SpecificFindInOrder ( const T * anEntry,
TInt & anIndex,
TLinearOrder < T > anOrder,
TInt aMode
) const [inline]

Finds the object pointer in the array whose object matches the specified object, using a binary search technique and an ordering algorithm.

Where there is more than one matching element, it finds the first, the last or any matching element as specified by the value of aMode.

The function assumes that existing object pointers in the array are ordered so that the objects themselves are in object order as determined by an algorithm supplied by the caller and packaged as a TLinearOrder<T> type.

TArrayFindMode

Parameters

const T * anEntry The object pointer to be found.
TInt & anIndex A TInt type supplied by the caller. On return, it contains an index value depending on whether a match is found and on the value of aMode. If there is no matching element in the array, then this is the index of the first element in the array that is bigger than the element being searched for - if no elements in the array are bigger, then the index value is the same as the total number of elements in the array. If there is a matching element, then what the index refers to depends on the value of aMode: if this is EArrayFindMode_First, then the index refers to the first matching element; if this is EArrayFindMode_Any, then the index can refer to any of the matching elements; if this is EArrayFindMode_Last, then the index refers to first element that follows the last matching element - if the last matching element is also the last element of the array, then the index value is the same as the total number of elements in the array.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.
TInt aMode Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

SpecificFindInOrderL(const T *, TLinearOrder< T >, TInt)

TInt SpecificFindInOrderL ( const T * anEntry,
TLinearOrder < T > anOrder,
TInt aMode
) const [inline]

Finds the object pointer in the array whose object matches the specified object, using a binary search technique and an ordering algorithm.

In the case that there is more than one matching element finds the first, last or any match as specified by the value of aMode.

The function assumes that existing object pointers in the array are ordered so that the objects themselves are in object order as determined by an algorithm supplied by the caller and packaged as a TLinearOrder<T> type.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound if no matching entry exists.
TArrayFindMode

Parameters

const T * anEntry The object pointer to be found.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.
TInt aMode Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

SpecificFindInOrderL(const T *, TInt &, TLinearOrder< T >, TInt)

void SpecificFindInOrderL ( const T * anEntry,
TInt & anIndex,
TLinearOrder < T > anOrder,
TInt aMode
) const [inline]

Finds the object pointer in the array whose object matches the specified object, using a binary search technique and an ordering algorithm.

Where there is more than one matching element, it finds the first, the last or any matching element as specified by the value of aMode.

The function assumes that existing object pointers in the array are ordered so that the objects themselves are in object order as determined by an algorithm supplied by the caller and packaged as a TLinearOrder<T>.

NOTE: This function is NOT AVAILABLE to code running on the kernel side.

leave
KErrNotFound, if no suitable object pointer can be found.
TArrayFindMode

Parameters

const T * anEntry The object pointer to be found.
TInt & anIndex A TInt type supplied by the caller. On return, it contains an index value depending on whether a match is found and on the value of aMode. If there is no matching element in the array, then this is the index of the first element in the array that is bigger than the element being searched for - if no elements in the array are bigger, then the index value is the same as the total number of elements in the array. If there is a matching element, then what the index refers to depends on the value of aMode: if this is EArrayFindMode_First, then the index refers to the first matching element; if this is EArrayFindMode_Any, then the index can refer to any of the matching elements; if this is EArrayFindMode_Last, then the index refers to first element that follows the last matching element - if the last matching element is also the last element of the array, then the index value is the same as the total number of elements in the array.
TLinearOrder < T > anOrder A package encapsulating the function which determines the order of two class T objects.
TInt aMode Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindModeenum values.

operator[](TInt)

T *const & operator[] ( TInt anIndex ) const [inline]

Gets a reference to the object pointer located at the specified position within the array.

The compiler chooses this option if the returned reference is used in an expression where the reference cannot be modified.

panic
USER 130, if anIndex is negative, or is greater than the number of objects currently in the array.

Parameters

TInt anIndex The position of the object pointer within the array. The position is relative to zero, i.e. zero implies the object pointer at the beginning of the array.

operator[](TInt)

T *& operator[] ( TInt anIndex ) [inline]

Gets a reference to the object pointer located at the specified position within the array.

The compiler chooses this option if the returned reference is used in an expression where the reference can be modified.

panic
USER 130, if anIndex is negative, or is greater than the number of objects currently in the array.

Parameters

TInt anIndex The position of the object pointer within the array. The position is relative to zero, i.e. zero implies the object pointer at the beginning of the array.

Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License v1.0.