Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: e32cmn.h

Class RPointerArray

class RPointerArray : private RPointerArrayBase;

Description

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.

Derivation

Members

Defined in RPointerArray:
Append(), AppendL(), Array(), Close(), Compress(), Count(), Find(), Find(), Find(), FindInAddressOrder(), FindInAddressOrder(), FindInAddressOrderL(), FindInAddressOrderL(), FindInOrder(), FindInOrder(), FindInOrder(), FindInOrderL(), FindInOrderL(), FindL(), FindL(), FindReverse(), FindReverse(), FindReverse(), FindReverseL(), FindReverseL(), GranularCompress(), Insert(), InsertInAddressOrder(), InsertInAddressOrderAllowRepeats(), InsertInAddressOrderAllowRepeatsL(), InsertInAddressOrderL(), InsertInOrder(), InsertInOrderAllowRepeats(), InsertInOrderAllowRepeatsL(), InsertInOrderL(), InsertL(), RPointerArray(), RPointerArray(), RPointerArray(), RPointerArray(), Remove(), Reserve(), ReserveL(), Reset(), ResetAndDestroy(), Sort(), SortIntoAddressOrder(), SpecificFindInAddressOrder(), SpecificFindInAddressOrder(), SpecificFindInAddressOrderL(), SpecificFindInAddressOrderL(), SpecificFindInOrder(), SpecificFindInOrder(), SpecificFindInOrderL(), SpecificFindInOrderL(), operator[](), operator[]()


Construction and destruction


RPointerArray()

inline RPointerArray();

Description

Default C++ constructor.

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


RPointerArray()

inline RPointerArray(TInt aGranularity);

Description

C++ constructor with granularity.

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

Parameters

TInt aGranularity

The granularity of the array.

Panic codes

USER

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


RPointerArray()

inline RPointerArray(TInt aMinGrowBy, TInt aFactor);

Description

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.

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.

Panic codes

USER

192, if aMinGrowBy<=0 or aMinGrowBy>65535.

USER

193, if aFactor<=257 or aFactor>32767.


RPointerArray()

inline RPointerArray(T **aEntries, TInt aCount);

Description

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.

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.

Panic codes

USER

156, if aCount is not positive.

[Top]


Member functions


Close()

inline void Close();

Description

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.


Count()

inline TInt Count() const;

Description

Gets the number of object pointers in the array.

Return value

TInt

The number of object pointers in the array.


operator[]()

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

Description

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.

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.

Return value

T *const &

A const reference to the object pointer at position anIndex within the array.

Panic codes

USER

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


operator[]()

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

Description

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.

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.

Return value

T *&

A non-const reference to the object pointer at position anIndex within the array.

Panic codes

USER

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


Append()

inline TInt Append(const T *anEntry);

Description

Appends an object pointer onto the array.

Parameters

const T *anEntry

The object pointer to be appended.

Return value

TInt

KErrNone, if the insertion is successful, otherwise one of the system wide error codes.


Insert()

inline TInt Insert(const T *anEntry, TInt aPos);

Description

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

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.

Return value

TInt

KErrNone, if the insertion is successful, otherwise one of the system wide error codes.

Panic codes

USER

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


Remove()

inline void Remove(TInt anIndex);

Description

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

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

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.

Panic codes

USER

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


Compress()

inline void Compress();

Description

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.


Reset()

inline void Reset();

Description

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();

Description

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.


Find()

inline TInt Find(const T *anEntry) const;

Description

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.

Return value

TInt

The index of the first matching object pointer within the array. KErrNotFound, if no matching object pointer can be found.


Find()

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

Description

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.

Return value

TInt

The index of the first matching object pointer within the array. KErrNotFound, if no suitable object pointer can be found.


Find()

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

Description

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.

Return value

TInt

The index of the first matching object pointer within the array. KErrNotFound, if no suitable object pointer can be found.


FindReverse()

inline TInt FindReverse(const T *anEntry) const;

Description

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.

Return value

TInt

The index of the last matching object pointer within the array. KErrNotFound, if no matching object pointer can be found.


FindReverse()

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

Description

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.

Return value

TInt

The index of the last matching object pointer within the array. KErrNotFound, if no suitable object pointer can be found.


FindReverse()

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

Description

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.

Return value

TInt

The index of the first matching object pointer within the array. KErrNotFound, if no suitable object pointer can be found.


FindInAddressOrder()

inline TInt FindInAddressOrder(const T *anEntry) const;

Description

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.

Return value

TInt

The index of the matching object pointer within the array or KErrNotFound if no suitable object pointer can be found.


FindInOrder()

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

Description

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.

Return value

TInt

The index of the matching object pointer within the array or KErrNotFound, if no suitable object pointer can be found.


FindInAddressOrder()

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

Description

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.

Return value

TInt

KErrNone, if a matching object pointer is found. KErrNotFound, if no suitable object pointer can be found.


FindInOrder()

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

Description

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.

Return value

TInt

KErrNone, if a matching object pointer is found. KErrNotFound, if no suitable object pointer can be found.


FindInOrder()

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

Description

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.

Return value

TInt

The index of the matching object pointer within the array. KErrNotFound, if no suitable object pointer can be found.


SpecificFindInAddressOrder()

inline TInt SpecificFindInAddressOrder(const T *anEntry, TInt aMode) const;

Description

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.

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.

Return value

TInt

KErrNotFound, if there is no matching element, otherwise the array index of a matching element - 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.


SpecificFindInOrder()

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

Description

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.

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.

Return value

TInt

KErrNotFound, if there is no matching element, otherwise the array index of a matching element - 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.


SpecificFindInAddressOrder()

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

Description

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.

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.

Return value

TInt

KErrNone, if a matching object pointer is found. KErrNotFound, if no suitable object pointer can be found.


SpecificFindInOrder()

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

Description

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.

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.

Return value

TInt

KErrNone, if a matching object pointer is found. KErrNotFound, if no suitable object pointer can be found.


InsertInAddressOrder()

inline TInt InsertInAddressOrder(const T *anEntry);

Description

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.

Return value

TInt

KErrNone, if the insertion is successful; KErrAlreadyExists, if an attempt is being made to insert a duplicate entry; otherwise one of the other system wide error codes.


InsertInOrder()

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

Description

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.

Return value

TInt

KErrNone, if the insertion is successful; KErrAlreadyExists, if an attempt is being made to insert a duplicate entry; otherwise one of the other system wide error codes.


InsertInAddressOrderAllowRepeats()

inline TInt InsertInAddressOrderAllowRepeats(const T *anEntry);

Description

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.

Return value

TInt

KErrNone, if the insertion is successful, otherwise one of the system wide error codes.


InsertInOrderAllowRepeats()

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

Description

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.

Return value

TInt

KErrNone, if the insertion is successful, otherwise one of the system wide error codes.


AppendL()

inline void AppendL(const T *anEntry);

Description

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.


InsertL()

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

Description

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.

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.

Panic codes

USER

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


FindL()

inline TInt FindL(const T *anEntry) const;

Description

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.

Parameters

const T *anEntry

The object pointer to be found.

Return value

TInt

The index of the first matching object pointer within the array.

Leave codes

KErrNotFound,

if no matching object pointer can be found.


FindL()

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

Description

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.

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.

Return value

TInt

The index of the first matching object pointer within the array.

Leave codes

KErrNotFound,

if no suitable object pointer can be found.


FindReverseL()

inline TInt FindReverseL(const T *anEntry) const;

Description

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.

Parameters

const T *anEntry

The object pointer to be found.

Return value

TInt

The index of the last matching object pointer within the array.

Leave codes

KErrNotFound,

if no matching object pointer can be found.


FindReverseL()

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

Description

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.

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.

Return value

TInt

The index of the last matching object pointer within the array.

Leave codes

KErrNotFound,

if no suitable object pointer can be found.


FindInAddressOrderL()

inline TInt FindInAddressOrderL(const T *anEntry) const;

Description

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.

Parameters

const T *anEntry

The object pointer to be found.

Return value

TInt

The index of the matching object pointer within the array

Leave codes

KErrNotFound,

if no suitable object pointer can be found.


FindInOrderL()

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

Description

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.

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.

Return value

TInt

The index of the matching object pointer within the array.

Leave codes

KErrNotFound,

if no suitable object pointer can be found.


FindInAddressOrderL()

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

Description

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.

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.

Leave codes

KErrNotFound,

if no suitable object pointer can be found.


FindInOrderL()

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

Description

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.

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.

Leave codes

KErrNotFound,

if no suitable object pointer can be found.


SpecificFindInAddressOrderL()

inline TInt SpecificFindInAddressOrderL(const T *anEntry, TInt aMode) const;

Description

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.

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.

Return value

TInt

If there is a matching element, the array index of a matching element - 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.

Leave codes

KErrNotFound

if no matching entry exists.


SpecificFindInOrderL()

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

Description

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.

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.

Return value

TInt

If there is a matching element, the array index of a matching element - 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.

Leave codes

KErrNotFound

if no matching entry exists.


SpecificFindInAddressOrderL()

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

Description

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.

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.

Leave codes

KErrNotFound,

if no suitable object pointer can be found.


SpecificFindInOrderL()

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

Description

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.

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.

Leave codes

KErrNotFound,

if no suitable object pointer can be found.


InsertInAddressOrderL()

inline void InsertInAddressOrderL(const T *anEntry);

Description

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.


InsertInOrderL()

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

Description

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.


InsertInAddressOrderAllowRepeatsL()

inline void InsertInAddressOrderAllowRepeatsL(const T *anEntry);

Description

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.


InsertInOrderAllowRepeatsL()

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

Description

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.


GranularCompress()

inline void GranularCompress();

Description

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.


Reserve()

inline TInt Reserve(TInt aCount);

Description

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

Return value

TInt

KErrNone If the operation completed successfully KErrNoMemory If the requested amount of memory could not be allocated


ReserveL()

inline void ReserveL(TInt aCount);

Description

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

Leave codes

KErrNoMemory

If the requested amount of memory could not be allocated


SortIntoAddressOrder()

inline void SortIntoAddressOrder();

Description

Sorts the object pointers within the array into address order.


Sort()

inline void Sort(TLinearOrder< T > anOrder);

Description

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.


Array()

inline TArray< T * > Array() const;

Description

Constructs and returns a generic array.

Return value

TArray< T * >

A generic array representing this array.

See also: