RArray< TInt > Class Template Reference

#include <e32cmn.h>

Link against: EAACPlusAudioControllerUtility.lib

template <>

class RArray< TInt > : private RPointerArrayBase

Inherits from

RArray< TInt >
- RPointerArrayBase

Public Member Functions
	RArray()
	RArray(TInt)
	RArray(TInt, TInt)
	RArray(TInt *, TInt)
TInt	Append(TInt)
void	AppendL(TInt)
TArray< TInt >	Array()
void	Close()
void	Compress()
TInt	Count()
TInt	Find(TInt)
TInt	FindInOrder(TInt)
TInt	FindInOrder(TInt, TInt &)
TInt	FindInOrderL(TInt)
void	FindInOrderL(TInt, TInt &)
TInt	FindL(TInt)
TInt	FindReverse(TInt)
TInt	FindReverseL(TInt)
void	GranularCompress()
TInt	Insert(TInt, TInt)
TInt	InsertInOrder(TInt)
TInt	InsertInOrderAllowRepeats(TInt)
void	InsertInOrderAllowRepeatsL(TInt)
void	InsertInOrderL(TInt)
void	InsertL(TInt, TInt)
void	Remove(TInt)
TInt	Reserve(TInt)
void	ReserveL(TInt)
void	Reset()
void	Sort()
TInt	SpecificFindInOrder(TInt, TInt)
TInt	SpecificFindInOrder(TInt, TInt &, TInt)
TInt	SpecificFindInOrderL(TInt, TInt)
void	SpecificFindInOrderL(TInt, TInt &, TInt)
const TInt &	operator[](TInt)
TInt &	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()

Detailed Description

A simple and efficient specialized array of signed integers offering standard array behaviour.

Note that derivation from RPointerArrayBase is private.

Constructor & Destructor Documentation

RArray ( )

RArray

(

)

[inline]

Constructs an array object for an array of signed integers with default granularity.

The default granularity is 8.

RArray ( TInt )

RArray

(

TInt

aGranularity

)

[inline, explicit]

Constructs an array object for an array of signed integers with the specified granularity.

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

Parameter	Description
aGranularity	The granularity of the array.

RArray ( TInt, TInt )

RArray	(	TInt	aMinGrowBy,
		TInt	aFactor
	)	[inline]

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

This constructs an array object for an array of signed integers 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.

Parameter	Description
aMinGrowBy	The minimum growth step of the array. Must be between 1 and 65535 inclusive.
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.

RArray ( TInt *, TInt )

RArray	(	TInt *	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 TInt objects. Ownership of the set of entries does not transfer to this RArray object.

The purpose of constructing an array in this way is to allow sorting and finding operations to be done without further allocation of memory.

Parameter	Description
aEntries	A pointer to the first entry of type class TInt in the set of entries belonging to the existing array.
aCount	The number of entries in the existing array.

Member Function Documentation

Append ( TInt )

TInt

Append

(

TInt

anEntry

)

[inline]

Appends a signed integer onto the array.

Parameter	Description
anEntry	The signed integer to be appended.

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

AppendL ( TInt )

void

AppendL

(

TInt

anEntry

)

[inline]

Appends a signed integer 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.

Parameter	Description
anEntry	The signed integer to be appended.

Array ( )

TArray< TInt >

Array

(

)

const [inline]

Constructs and returns a generic array.

Close ( )

void

(

)

[inline]

Reimplemented from RPointerArrayBase::Close()

Closes the array and frees all memory allocated to the array.

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

Compress ( )

void

Compress

(

)

[inline]

Reimplemented from RPointerArrayBase::Compress()

Compresses the array down to a minimum.

After a call to this function, the memory allocated to the array is just sufficient for its entries. Subsequently adding a new signed integer to the array always results in a re-allocation of memory.

Count ( )

TInt

Count

(

)

const [inline]

Reimplemented from RPointerArrayBase::Count()const

Gets the number of signed integers in the array.

Returns: The number of signed integers in the array.

Find ( TInt )

TInt

Find

(

TInt

anEntry

)

const [inline]

Finds the first signed integer in the array which matches the specified signed integer using a sequential search.

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

Parameter	Description
anEntry	The signed integer to be found.

Returns: The index of the first matching signed integer within the array. KErrNotFound, if no matching entry can be found.

FindInOrder ( TInt )

TInt

FindInOrder

(

TInt

anEntry

)

const [inline]

Finds the signed integer in the array that matches the specified signed integer using a binary search technique.

The function assumes that the array is in signed integer order.

Parameter	Description
anEntry	The signed integer to find.

Returns: The index of the matching signed integer within the array or KErrNotFound, if no match can be found.

FindInOrder ( TInt, TInt & )

TInt	FindInOrder	(	TInt	anEntry,
			TInt &	anIndex
		)	const [inline]

Finds the signed integer in the array that matches the specified signed integer using a binary search technique.

The function assumes that the array is in signed integer order.

Parameter

Description

anEntry

The signed integer to find.

anIndex

A TInt suplied by the caller. On return contains an index value. If the function returns KErrNone, this is the index of the matching signed integer within the array. If the function returns KErrNotFound, this is the index of the first signed integer within the array that is bigger than the signed integer being searched for - if no signed integers within the array are bigger, then the index value is the same as the total number of signed integers within the array.

Returns: KErrNone if a matching signed integer is found. KErrNotFound if no match can be found.

FindInOrderL ( TInt )

TInt

FindInOrderL

(

TInt

anEntry

)

const [inline]

Finds the signed integer in the array that matches the specified signed integer using a binary search technique.

The function assumes that the array is in signed integer order.

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

leave: KErrNotFound, if no match can be found.

Parameter	Description
anEntry	The signed integer to be found.

Returns: The index of the matching signed integer within the array.

FindInOrderL ( TInt, TInt & )

void	FindInOrderL	(	TInt	anEntry,
			TInt &	anIndex
		)	const [inline]

Finds the signed integer in the array that matches the specified signed integer using a binary search technique.

The function assumes that the array is in signed integer order.

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

leave: KErrNotFound if no match can be found.

Parameter

Description

anEntry

The signed integer to be found.

anIndex

A reference to a signed integer into which the function puts an index value: If the function returns , this is the index of the matching signed integer within the array. If the function leaves with KErrNotFound, this is the index of the first signed integer within the array that is bigger than the signed integer being searched for - if no signed integers within the array are bigger, then the index value is the same as the total number of signed integers within the array.

FindL ( TInt )

TInt

FindL

(

TInt

anEntry

)

const [inline]

Finds the first signed integer in the array which matches the specified signed integer using a sequential search.

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

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

leave: KErrNotFound, if no matching entry can be found.

Parameter	Description
anEntry	The signed integer to be found.

Returns: The index of the first matching signed integer within the array.

FindReverse ( TInt )

TInt

FindReverse

(

TInt

anEntry

)

const [inline]

Finds the last signed integer in the array which matches the specified signed integer using a sequential search.

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

Parameter	Description
anEntry	The signed integer to be found.

Returns: The index of the last matching signed integer within the array. KErrNotFound, if no matching entry can be found.

FindReverseL ( TInt )

TInt

FindReverseL

(

TInt

anEntry

)

const [inline]

Finds the last signed integer in the array which matches the specified signed integer using a sequential search.

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

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

leave: KErrNotFound, if no matching entry can be found.

Parameter	Description
anEntry	The signed integer to be found.

Returns: The index of the last matching signed integer within the array.

GranularCompress ( )

void

GranularCompress

(

)

[inline]

Reimplemented from RPointerArrayBase::GranularCompress()

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 entries. Adding new signed integers to the array does not result in a re-allocation of memory until the total number of entries reaches a multiple of the granularity.

Insert ( TInt, TInt )

TInt	Insert	(	TInt	anEntry,
			TInt	aPos
		)	[inline]

Inserts a signed integer into the array at the specified position.

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

Parameter	Description
anEntry	The signed integer to be inserted.
aPos	The position within the array where the signed integer is to be inserted. The position is relative to zero, i.e. zero implies that an entry is inserted at the beginning of the array.

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

InsertInOrder ( TInt )

TInt

InsertInOrder

(

TInt

anEntry

)

[inline]

Inserts a signed integer into the array in signed integer order.

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

The function assumes that existing entries within the array are in signed integer order.

Parameter	Description
anEntry	The signed integer to be inserted

Returns: 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.

InsertInOrderAllowRepeats ( TInt )

TInt

InsertInOrderAllowRepeats

(

TInt

anEntry

)

[inline]

Inserts a signed integer into the array in signed integer order, allowing duplicates.

If anEntry is a duplicate of an existing entry in the array, then the new signed integer is inserted after the existing one. If more than one duplicate entry already exists in the array, then any new duplicate signed integer is inserted after the last one.

The function assumes that existing entries within the array are in signed integer order.

Parameter	Description
anEntry	The signed integer to be inserted.

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

InsertInOrderAllowRepeatsL ( TInt )

void

InsertInOrderAllowRepeatsL

(

TInt

anEntry

)

[inline]

Inserts a signed integer into the array in signed integer order, allowing duplicates.

The function assumes that existing entries within the array are in signed integer 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.

Parameter	Description
anEntry	The signed integer to be inserted.

InsertInOrderL ( TInt )

void

InsertInOrderL

(

TInt

anEntry

)

[inline]

Inserts a signed integer into the array in signed integer order.

No duplicate entries are permitted.

The function assumes that existing entries within the array are in signed integer 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.

Parameter	Description
anEntry	The signed integer to be inserted.

InsertL ( TInt, TInt )

void	InsertL	(	TInt	anEntry,
			TInt	aPos
		)	[inline]

Inserts a signed integer 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 entries currently in the array.

Parameter	Description
anEntry	The signed integer to be inserted.
aPos	The position within the array where the signed integer is to be inserted. The position is relative to zero, i.e. zero implies that an entry is inserted at the beginning of the array.

Remove ( TInt )

void

Remove

(

TInt

anIndex

)

[inline]

Reimplemented from RPointerArrayBase::Remove(TInt)

Removes the signed integer at the specified position from the array.

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

Parameter	Description
anIndex	The position within the array from where the signed integer is to be removed. The position is relative to zero, i.e. zero implies that an entry 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 integers specified. Adding new integers to the array does not result in a re-allocation of memory until the the total number of integers exceeds the specified count.

Parameter	Description
aCount	The number of integers for which space should be reserved

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

ReserveL ( TInt )

void

ReserveL

(

TInt

aCount

)

[inline]

Reserves space for the specified number of elements.

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

Parameter	Description
aCount	The number of integers for which space should be reserved

Reset ( )

void

Reset

(

)

[inline]

Reimplemented from RPointerArrayBase::Reset()

Empties the array.

The function 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.

Sort ( )

void

Sort

(

)

[inline]

Sorts the array entries into signed integer order.

SpecificFindInOrder ( TInt, TInt )

TInt	SpecificFindInOrder	(	TInt	anEntry,
			TInt	aMode
		)	const [inline]

Finds the signed integer in the array that matches the specified signed integer using a binary search technique.

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

The function assumes that the array is in signed integer order.

See also: TArrayFindMode

Parameter	Description
anEntry	The signed integer to be found.
aMode	Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

Returns: 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 ( TInt, TInt &, TInt )

TInt	SpecificFindInOrder	(	TInt	anEntry,
			TInt &	anIndex,
			TInt	aMode
		)	const [inline]

Finds the signed integer in the array that matches the specified signed integer using a binary search technique.

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

The function assumes that the array is in signed integer order.

See also: TArrayFindMode

Parameter	Description
anEntry	The signed integer to be found.
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.
aMode	Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

Returns: KErrNone, if a matching element is found; KErrNotFound, if no suitable element can be found.

SpecificFindInOrderL ( TInt, TInt )

TInt	SpecificFindInOrderL	(	TInt	anEntry,
			TInt	aMode
		)	const [inline]

Finds the signed integer in the array that matches the specified signed integer using a binary search technique.

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

The function assumes that the array is in signed integer order.

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

leave: KErrNotFound if no matching entry exists.

See also: TArrayFindMode

Parameter	Description
anEntry	The signed integer to be found.
aMode	Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

Returns: 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.

SpecificFindInOrderL ( TInt, TInt &, TInt )

void	SpecificFindInOrderL	(	TInt	anEntry,
			TInt &	anIndex,
			TInt	aMode
		)	const [inline]

Finds the signed integer in the array that matches the specified signed integer using a binary search technique.

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

The function assumes that the array is in signed integer order.

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

leave: KErrNotFound if no matching entry exists.

See also: TArrayFindMode

Parameter	Description
anEntry	The signed integer to be found.
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.
aMode	Specifies whether to find the first match, the last match or any match, as defined by one of the TArrayFindMode enum values.

operator[] ( TInt )

const TInt &

operator[]

(

TInt

anIndex

)

const [inline]

Gets a reference to the signed integer located at a specified position within the array.

The compiler chooses this function 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 entries currently in the array.

Parameter	Description
anIndex	The position of the signed integer within the array. The position is relative to zero, i.e. zero implies the entry at the beginning of the array.

Returns: A const reference to the signed integer at position anIndex within the array.

operator[] ( TInt )

TInt &

operator[]

(

TInt

anIndex

)

[inline]

Gets a reference to the signed integer located at a specified position within the array.

The compiler chooses this function 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 entries currently in the array.

Parameter	Description
anIndex	The position of the signed integer within the array. The position is relative to zero, i.e. zero implies the entry at the beginning of the array.

Returns: A non-const reference to the signed integer at position anIndex within the array.