Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
CArrayFixFlat< TAny > Class Reference

An array of fixed length untyped objects using a flat dynamic buffer. More...

#include <e32base.h>

Inheritance diagram for CArrayFixFlat< TAny >:
CArrayFix< TAny > CArrayFixBase CBase

Public Member Functions

 CArrayFixFlat (TInt aRecordLength, TInt aGranularity)
 Constructs a flat array of fixed length objects with the specified granularity to contain elements of the specified length.
 
void SetReserveL (TInt aCount)
 Reserves space in the array buffer.
 
- Public Member Functions inherited from CArrayFix< TAny >
 CArrayFix (TBufRep aRep, TInt aRecordLength, TInt aGranularity)
 
const TAny * At (TInt anIndex) const
 Gets a pointer to the untyped element located at the specified position within the array.
 
const TAny * End (TInt anIndex) const
 Gets a pointer to the first byte following the end of the contiguous region containing the element at the specfied position within the array.
 
const TAny * Back (TInt anIndex) const
 Gets a pointer to the beginning of a contiguous region.
 
TAny * At (TInt anIndex)
 Gets a pointer to the untyped element located at the specified position within the array.
 
TAny * End (TInt anIndex)
 Gets a pointer to the first byte following the end of the contiguous region containing the element at the specfied position within the array.
 
TAny * Back (TInt anIndex)
 Gets a pointer to the beginning of a contiguous region.
 
void AppendL (const TAny *aPtr)
 Appends the specified untyped element onto the end of the array.
 
void AppendL (const TAny *aPtr, TInt aCount)
 Appends one or more untyped elements onto the end of the array.
 
TAny * ExtendL ()
 Expands the array by the length of one element at the end of the array and returns a pointer to this new location.
 
- Public Member Functions inherited from CArrayFixBase
IMPORT_C ~CArrayFixBase ()
 Destructor.
 
TInt Count () const
 Gets the number of elements held in the array.
 
TInt Length () const
 Gets the length of an element.
 
IMPORT_C void Compress ()
 Compresses the array.
 
IMPORT_C void Reset ()
 Deletes all elements from the array and frees the memory allocated to the array buffer.
 
IMPORT_C TInt Sort (TKeyArrayFix &aKey)
 Sorts the elements of the array into key sequence.
 
IMPORT_C TAny * At (TInt anIndex) const
 Index into the array.
 
IMPORT_C TAny * End (TInt anIndex) const
 Return a pointer past contiguous elements starting at anIndex.
 
IMPORT_C TAny * Back (TInt anIndex) const
 Return a pointer to contiguous elements before anIndex.
 
IMPORT_C void Delete (TInt anIndex)
 Deletes a single element from the array at a specified position.
 
IMPORT_C void Delete (TInt anIndex, TInt aCount)
 Deletes one or more contiguous elements from the array, starting at a specific position.
 
IMPORT_C TAny * ExpandL (TInt anIndex)
 Expand the array to make room for a new record at anIndex.
 
IMPORT_C TInt Find (const TAny *aPtr, TKeyArrayFix &aKey, TInt &anIndex) const
 Find in the array using a sequential search.
 
IMPORT_C TInt FindIsq (const TAny *aPtr, TKeyArrayFix &aKey, TInt &anIndex) const
 Find in the array using a binary search.
 
IMPORT_C void InsertL (TInt anIndex, const TAny *aPtr)
 Insert a record into the array.
 
IMPORT_C void InsertL (TInt anIndex, const TAny *aPtr, TInt aCount)
 Insert aCount records into the array.
 
IMPORT_C TInt InsertIsqL (const TAny *aPtr, TKeyArrayFix &aKey)
 Insert in sequence, no duplicates allowed.
 
IMPORT_C TInt InsertIsqAllowDuplicatesL (const TAny *aPtr, TKeyArrayFix &aKey)
 Insert in sequence, allow duplicates.
 
IMPORT_C void ResizeL (TInt aCount, const TAny *aPtr)
 Resize the array to contain aCount records, copying a record into any new slots.
 
- Public Member Functions inherited from CBase
 CBase ()
 Default constructor.
 
virtual IMPORT_C ~CBase ()
 Virtual destructor.
 
TAny * operator new (TUint aSize, TAny *aBase) __NO_THROW
 Initialises the object to binary zeroes.
 
TAny * operator new (TUint aSize) __NO_THROW
 Allocates the object from the heap and then initialises its contents to binary zeroes.
 
TAny * operator new (TUint aSize, TLeave)
 Allocates the object from the heap and then initialises its contents to binary zeroes.
 
TAny * operator new (TUint aSize, TUint aExtraSize) __NO_THROW
 Allocates the object from the heap and then initialises its contents to binary zeroes.
 
TAny * operator new (TUint aSize, TLeave, TUint aExtraSize)
 Allocates the object from the heap and then initialises its contents to binary zeroes.
 

Additional Inherited Members

- Static Public Member Functions inherited from CBase
static IMPORT_C void Delete (CBase *aPtr)
 Deletes the specified object.
 
- Protected Member Functions inherited from CArrayFixBase
IMPORT_C CArrayFixBase (TBufRep aRep, TInt aRecordLength, TInt aGranularity)
 Constructor.
 
IMPORT_C void InsertRepL (TInt anIndex, const TAny *aPtr, TInt aReplicas)
 Insert aReplicas copies of a record into the array.
 
IMPORT_C void SetKey (TKeyArrayFix &aKey) const
 Set the key data.
 
IMPORT_C void SetReserveFlatL (TInt aCount)
 Reserve space to contain aCount items.
 
- Protected Member Functions inherited from CBase
virtual IMPORT_C TInt Extension_ (TUint aExtensionId, TAny *&a0, TAny *a1)
 Extension function.
 
- Static Protected Member Functions inherited from CArrayFixBase
static IMPORT_C TInt CountR (const CBase *aPtr)
 Return the number of items in the array.
 
static IMPORT_C const TAny * AtR (const CBase *aPtr, TInt anIndex)
 Return the address of an item in the array.
 

Detailed Description

An array of fixed length untyped objects using a flat dynamic buffer.

The array elements are contained within a CBufFlat.

The class is useful for constructing an array of fixed length buffers, where the length is decided at run time.

This class is also useful as a data member of a base class in a thin template class/base class pair where the type of the array element is not known until the owning thin template class is instantiated.

See also
CBufFlat
API status
Published to all clients. Released API.

Definition at line 497 of file e32base.h.

Constructor & Destructor Documentation

◆ CArrayFixFlat()

CArrayFixFlat< TAny >::CArrayFixFlat ( TInt  aRecordLength,
TInt  aGranularity 
)
inline

Constructs a flat array of fixed length objects with the specified granularity to contain elements of the specified length.

Note that no memory is allocated to the array buffer by this constructor.

Parameters
aRecordLengthThe length of the elements of this fixed length array.
aGranularityThe granularity of the array.

Panic condition: E32USER-CBase 17, if aRecordLength is not positive.

Panic condition: E32USER-CBase 18, if aGranularity is not positive.

(generated from Symbian Developer Library)

Member Function Documentation

◆ SetReserveL()

void CArrayFixFlat< TAny >::SetReserveL ( TInt  aCount)
inline

Reserves space in the array buffer.

If necessary, the array buffer is allocated or re-allocated so that it can accommodate the specified number of elements.

After a successful call to this function, elements can be added to the array and the process is guaranteed not to fail for lack of memory - provided the total number of elements does not exceed the specified number.

This function does not increase the number of elements in the array; i.e. the member function CArrayFixBase::Count() returns the same value both before and after a call to this function.

Parameters
aCountThe total number of elements for which space is to be reserved.

Panic condition: E32USER-CBase 27, if aCount is less than the current number of elements in the array.

(generated from Symbian Developer Library)


The documentation for this class was generated from the following files: