Symbian^3 Application Developer Library >

CArrayFixBase Class Reference

class CArrayFixBase : public CBase

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.

Inherits from

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()
Private Attributes
CBufBase * iBase
TInt iCount
TBufRep iCreateRep
TInt iGranularity
TInt iLength

Constructor & Destructor Documentation

CArrayFixBase(TBufRep, TInt, TInt)

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

Parameters

TBufRep aRep
TInt aRecordLength
TInt aGranularity

~CArrayFixBase()

IMPORT_C ~CArrayFixBase ( )

Destructor.

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

Member Functions Documentation

At(TInt)

IMPORT_C TAny * At ( TInt anIndex ) const

Parameters

TInt anIndex

AtR(const CBase *, TInt)

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

Parameters

const CBase * aPtr
TInt anIndex

Back(TInt)

IMPORT_C TAny * Back ( TInt anIndex ) const

Parameters

TInt anIndex

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.

CountR(const CBase *)

IMPORT_C TInt CountR ( const CBase * aPtr ) [protected, static]

Parameters

const CBase * aPtr

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.

panic
E32USER-CBase 21, if anIndex is negative or is greater than or equal to the number of elements currently in the array.
CArrayFixBase::Compress

Parameters

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

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.

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

Parameters

TInt 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.
TInt aCount The number of contiguous elements to be deleted from the array.

End(TInt)

IMPORT_C TAny * End ( TInt anIndex ) const

Parameters

TInt anIndex

ExpandL(TInt)

IMPORT_C TAny * ExpandL ( TInt anIndex )

Parameters

TInt anIndex

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

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

Parameters

const TAny * aPtr
TKeyArrayFix & aKey
TInt & anIndex

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

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

Parameters

const TAny * aPtr
TKeyArrayFix & aKey
TInt & anIndex

InsertIsqAllowDuplicatesL(const TAny *, TKeyArrayFix &)

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

Parameters

const TAny * aPtr
TKeyArrayFix & aKey

InsertIsqL(const TAny *, TKeyArrayFix &)

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

Parameters

const TAny * aPtr
TKeyArrayFix & aKey

InsertL(TInt, const TAny *)

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

Parameters

TInt anIndex
const TAny * aPtr

InsertL(TInt, const TAny *, TInt)

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

Parameters

TInt anIndex
const TAny * aPtr
TInt aCount

InsertRepL(TInt, const TAny *, TInt)

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

Parameters

TInt anIndex
const TAny * aPtr
TInt aReplicas

Length()

TInt Length ( ) const [inline]

Gets the length of an element.

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
)

Parameters

TInt aCount
const TAny * aPtr

SetKey(TKeyArrayFix &)

IMPORT_C void SetKey ( TKeyArrayFix & aKey ) const [protected]

Parameters

TKeyArrayFix & aKey

SetReserveFlatL(TInt)

IMPORT_C void SetReserveFlatL ( TInt aCount ) [protected]

Parameters

TInt aCount

Sort(TKeyArrayFix &)

IMPORT_C TInt Sort ( TKeyArrayFix & aKey )

Sorts the elements of the array into key sequence.

Parameters

TKeyArrayFix & aKey The key object defining the properties of the key.

Member Data Documentation

CBufBase * iBase

CBufBase * iBase [private]

TInt iCount

TInt iCount [private]

TBufRep iCreateRep

TBufRep iCreateRep [private]

TInt iGranularity

TInt iGranularity [private]

TInt iLength

TInt iLength [private]

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.