CArrayFixBase Class Reference

#include <e32base.h>

Link against: euser_v5.lib

class CArrayFixBase : public CBase

Inherits from

CArrayFixBase
- CBase

Public Member Functions
	~CArrayFixBase()
IMPORT_C TAny *	At(TInt)
IMPORT_C TAny *	Back(TInt)
IMPORT_C void	Compress()
TInt	Count()
IMPORT_C void	Delete(TInt)
IMPORT_C void	Delete(TInt, TInt)
IMPORT_C TAny *	End(TInt)
IMPORT_C TAny *	ExpandL(TInt)
IMPORT_C TInt	Find(const TAny *, TKeyArrayFix &, TInt &)
IMPORT_C TInt	FindIsq(const TAny *, TKeyArrayFix &, TInt &)
IMPORT_C TInt	InsertIsqAllowDuplicatesL(const TAny *, TKeyArrayFix &)
IMPORT_C TInt	InsertIsqL(const TAny *, TKeyArrayFix &)
IMPORT_C void	InsertL(TInt, const TAny *)
IMPORT_C void	InsertL(TInt, const TAny *, TInt)
TInt	Length()
IMPORT_C void	Reset()
IMPORT_C void	ResizeL(TInt, const TAny *)
IMPORT_C TInt	Sort(TKeyArrayFix &)

Protected Member Functions
	CArrayFixBase(TBufRep, TInt, TInt)
IMPORT_C const TAny *	AtR(const CBase *, TInt)
IMPORT_C TInt	CountR(const CBase *)
IMPORT_C void	InsertRepL(TInt, const TAny *, TInt)
IMPORT_C void	SetKey(TKeyArrayFix &)
IMPORT_C void	SetReserveFlatL(TInt)

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

Base class for arrays of fixed length objects.

It provides implementation and public functions which are common to all arrays of this type.

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

Constructor & Destructor Documentation

CArrayFixBase ( TBufRep, TInt, TInt )

IMPORT_C	CArrayFixBase	(	TBufRep	aRep,
			TInt	aRecordLength,
			TInt	aGranularity
		)	[protected]

~CArrayFixBase ( )

IMPORT_C

~CArrayFixBase

(

)

Destructor.

This 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]

Back ( TInt )

IMPORT_C TAny *

Back

(

TInt

anIndex

)

const

Compress ( )

IMPORT_C void

Compress

(

)

Compresses the array.

The function removes the 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. This applies to both flat and segmented array buffers.

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

)

Deletes a single element from the array at a specified position.

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

Parameters
anIndex	The position within the array at which to delete the element, This is a value relative to zero.

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

Delete ( TInt, TInt )

IMPORT_C void	Delete	(	TInt	anIndex,
			TInt	aCount
		)

Deletes 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 CArrayFixBase::Compress() to return excess space to the heap.

Parameters
anIndex	The position within the array from where deletion of elements is to start. The position is relative to zero, i.e. zero implies that elements, starting with the first, are deleted from the array.
aCount	The number of contiguous elements to be deleted from the array.

Panic Codes
E32USER-CBase	21, if anIndex is negative, or is greater than or equal to the number of elements currently in the array.
E32USER-CBase	22, if aCount is negative.
E32USER-CBase	29, if the sum of anIndex and aCount is greater than or equal to the number of elements currently in the array.

End ( TInt )

IMPORT_C TAny *

End

(

TInt

anIndex

)

const

ExpandL ( TInt )

IMPORT_C TAny *

ExpandL

(

TInt

anIndex

)

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

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

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

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

InsertIsqAllowDuplicatesL ( const TAny *, TKeyArrayFix & )

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

InsertIsqL ( const TAny *, TKeyArrayFix & )

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

InsertL ( TInt, const TAny * )

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

InsertL ( TInt, const TAny *, TInt )

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

InsertRepL ( TInt, const TAny *, TInt )

IMPORT_C void	InsertRepL	(	TInt	anIndex,
			const TAny *	aPtr,
			TInt	aReplicas
		)	[protected]

Length ( )

TInt

Length

(

)

const [inline]

Gets the length of an element.

Return Value: The length of an element of type class T.

Reset ( )

IMPORT_C void

Reset

(

)

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

ResizeL ( TInt, const TAny * )

IMPORT_C void	ResizeL	(	TInt	aCount,
			const TAny *	aPtr
		)

SetKey ( TKeyArrayFix & )

IMPORT_C void

SetKey

(

TKeyArrayFix &

aKey

)

const [protected]

SetReserveFlatL ( TInt )

IMPORT_C void

SetReserveFlatL

(

TInt

aCount

)

[protected]

Sort ( TKeyArrayFix & )

IMPORT_C TInt

Sort

(

TKeyArrayFix &

aKey

)

Sorts the elements of the array into key sequence.

Parameters
aKey	The key object defining the properties of the key.

Return Value: KErrNone if the sort completes successfully. KErrGeneral if the stack overflows