CArrayPakBase Class Reference

#include <e32base.h>

Link against: euser_v5.lib

class CArrayPakBase : public CBase

Inherits from

CArrayPakBase
- CBase

Public Member Functions
	~CArrayPakBase()
IMPORT_C TAny *	At(TInt)
IMPORT_C void	Compress()
TInt	Count()
IMPORT_C void	Delete(TInt)
IMPORT_C void	Delete(TInt, TInt)
IMPORT_C TAny *	ExpandL(TInt, TInt)
IMPORT_C TInt	Find(const TAny *, TKeyArrayPak &, TInt &)
IMPORT_C TInt	FindIsq(const TAny *, TKeyArrayPak &, TInt &)
IMPORT_C TInt	InsertIsqAllowDuplicatesL(const TAny *, TInt, TKeyArrayPak &)
IMPORT_C TInt	InsertIsqL(const TAny *, TInt, TKeyArrayPak &)
IMPORT_C void	InsertL(TInt, const TAny *, TInt)
IMPORT_C TInt	Length(TInt)
IMPORT_C void	Reset()
IMPORT_C void	SortL(TKeyArrayVar &)

Protected Member Functions
	CArrayPakBase(TBufRep, TInt)
IMPORT_C const TAny *	AtR(const CBase *, TInt)
IMPORT_C void	BuildVarArrayL(CArrayVarFlat< TAny > *&)
IMPORT_C TInt	CountR(const CBase *)
IMPORT_C TInt	GetOffset(TInt)
IMPORT_C void	SetKey(TKeyArrayPak &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Detailed Description

An implementation base class for all variable length, packed arrays.

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

Constructor & Destructor Documentation

CArrayPakBase ( TBufRep, TInt )

IMPORT_C	CArrayPakBase	(	TBufRep	aRep,
			TInt	aGranularity
		)	[protected]

~CArrayPakBase ( )

IMPORT_C

~CArrayPakBase

(

)

Destructor.

Frees all resources owned by the object, prior to its destruction.

Member Function Documentation

At ( TInt )

IMPORT_C TAny *

(

TInt

anIndex

)

const

AtR ( const CBase *, TInt )

IMPORT_C const TAny *	AtR	(	const CBase *	aPtr,
			TInt	anIndex
		)	[protected, static]

BuildVarArrayL ( CArrayVarFlat< TAny > *& )

IMPORT_C void

BuildVarArrayL

(

CArrayVarFlat< TAny > *&

aVarFlat

)

[protected]

Compress ( )

IMPORT_C void

Compress

(

)

Removes excess space from the array buffer.

The effect is to reduce the memory allocated to the array buffer so that it is just sufficient to contain the elements of the array.

If the array is empty, then the memory allocated to the array buffer is freed.

Count ( )

TInt

Count

(

)

const [inline]

Gets the number of elements held in the array.

Return Value: The number of array elements.

CountR ( const CBase * )

IMPORT_C TInt

CountR

(

const CBase *

aPtr

)

[protected, static]

Delete ( TInt )

IMPORT_C void

Delete

(

TInt

anIndex

)

Removes a single element from the array.

Deleting elements from the array does not cause the array buffer to be automatically compressed. Call CArrayPakBase::Compress() to return excess space to the heap.

Parameters
anIndex	The position within the array of the element to delete, relative to zero.

Delete ( TInt, TInt )

IMPORT_C void	Delete	(	TInt	anIndex,
			TInt	aCount
		)

Removes one or more contiguous elements from the array, starting at a specific position.

Deleting elements from the array does not cause the array buffer to be automatically compressed. Call CArrayPakBase::Compress() to return excess space to the heap.

Parameters
anIndex	The position within the array from where deletion of elements is to start, relative to zero.
aCount	The number of elements to be deleted from the array.

Panic Codes
E32USER-CBase	21, if anIndex is negative or greater than the number of elements currently in the array.
E32USER-CBase	26, if aCount is negative.

ExpandL ( TInt, TInt )

IMPORT_C TAny *	ExpandL	(	TInt	anIndex,
			TInt	aLength
		)

Find ( const TAny *, TKeyArrayPak &, TInt & )

IMPORT_C TInt	Find	(	const TAny *	aPtr,
			TKeyArrayPak &	aKey,
			TInt &	anIndex
		)	const

FindIsq ( const TAny *, TKeyArrayPak &, TInt & )

IMPORT_C TInt	FindIsq	(	const TAny *	aPtr,
			TKeyArrayPak &	aKey,
			TInt &	anIndex
		)	const

GetOffset ( TInt )

IMPORT_C TInt

GetOffset

(

TInt

anIndex

)

const [protected]

InsertIsqAllowDuplicatesL ( const TAny *, TInt, TKeyArrayPak & )

IMPORT_C TInt	InsertIsqAllowDuplicatesL	(	const TAny *	aPtr,
			TInt	aLength,
			TKeyArrayPak &	aKey
		)

InsertIsqL ( const TAny *, TInt, TKeyArrayPak & )

IMPORT_C TInt	InsertIsqL	(	const TAny *	aPtr,
			TInt	aLength,
			TKeyArrayPak &	aKey
		)

InsertL ( TInt, const TAny *, TInt )

IMPORT_C void	InsertL	(	TInt	anIndex,
			const TAny *	aPtr,
			TInt	aLength
		)

Length ( TInt )

IMPORT_C TInt

Length

(

TInt

anIndex

)

const

Gets the length of the specified element.

Parameters
anIndex	The position of the element within the array. The position is relative to zero, (i.e. the first element in the array is at position 0).

Return Value: The length of the element at position anIndex.

Panic Codes
E32USER-CBase	21, if anIndex is negative or is greater than the number of elements currently in the array.

Reset ( )

IMPORT_C void

Reset

(

)

Deletes all elements from the array and frees the memory allocated to the array buffer.

SetKey ( TKeyArrayPak & )

IMPORT_C void

SetKey

(

TKeyArrayPak &

aKey

)

const [protected]

SortL ( TKeyArrayVar & )

IMPORT_C void

SortL

(

TKeyArrayVar &

aKey

)

Sorts the elements of the array into key sequence.

Note that the function requires a TKeyArrayVar key object because SortL() creates a temporary CArrayVarFlat array in its implementation and uses that array's Sort() member function.