TMCPtrArray< T > Class Template Reference
[MCCore]
List of all members.
Public Types |
typedef T | TTemplateType |
typedef T * | TValueType |
| The template type on which the array is based.
|
typedef TMCPtrIterator< T,
TMCPtrArray< T > > | iterator |
typedef TMCConstPtrIterator< T,
TMCPtrArray< T > > | const_iterator |
Public Member Functions |
| TMCPtrArray (void) |
| A type that represents the data type stored in the array.
|
| TMCPtrArray (uint32 initialCount, boolean initialZeroMem) |
| TMCPtrArray (uint32 initialCount, uint32 initialSpace, uint32 initialGrowSize, boolean initialZeroMem) |
| TMCPtrArray (const TMCPtrArray< T > &inFromArray) |
| TMCPtrArray (const TMCCountedPtrArray< T > &inFromCountedPtrArray) |
TMCPtrArray< T > & | operator= (const TMCCountedPtrArray< T > &fromCountedPtrArray) |
| TMCPtrArray (T **const &baseAddress, boolean inAquireMemory, uint32 elemCount, uint32 elemSpace) |
| TMCPtrArray (TMCPtrArray< T > &array, uint32 elemStart, uint32 elemCount) |
| ~TMCPtrArray (void) |
void | DeleteAndRemoveElements (uint32 startIndex, uint32 deleteCount) |
void | DeleteAndRemoveAll () |
TMCPtrArray< T > & | operator= (const TMCPtrArray< T > &fromArray) |
template<class TArray2 > |
void | QueryArray (const MCIID &iid, TArray2 &outArray) const |
| Fills outArray.
|
void | ArrayFree (void) |
boolean | IsValid (void) const |
int8 * | BaseAddress (void) |
const int8 * | BaseAddress (void) const |
uint32 | GetElemSize (void) const |
uint32 | GetGrowSize (void) const |
uint32 | GetElemSpace (void) const |
uint32 | GetElemCount (void) const |
boolean | GetZeroMem (void) const |
boolean | ExternalMemory () |
boolean | GetSmartGrow (void) const |
T ** | ArrayData (void) |
T **const | ArrayData (void) const |
void | SetZeroMem (boolean z) |
void | SetValid (boolean valid) |
void | SetGrowSize (uint32 g) |
void | SetSmartGrow () |
boolean | SetElemSpace (uint32 n) |
boolean | SetElemCount (uint32 n) |
boolean | AddElemCount (uint32 n) |
const_iterator | Begin (void) const |
iterator | Begin (void) |
const_iterator | End (void) const |
iterator | End (void) |
T *& | FirstElem (void) |
const T *const | FirstElem (void) const |
T *& | LastElem (void) |
const T *const | LastElem (void) const |
void | Erase (const iterator &elementToErase) |
void | Erase (const iterator &start, const iterator &end) |
boolean | CopyElems (const TMCPtrArray< T > &fromArray, uint32 startIndex, uint32 numItems, uint32 insertAtIndex) |
boolean | Append (const TMCPtrArray< T > &fromArray) |
void | FillWithValue (const T *inValue, uint32 inStart=kBeginIndex, uint32 inLength=kUnusedIndex) |
void | Swap (TMCPtrArray< T > &fromArray) |
T ** | Pointer (uint32 i) |
T ** | Pointer (uint32 i) const |
T *& | operator[] (uint32 i) |
T *const & | operator[] (uint32 i) const |
void | SetElem (uint32 index, const T *data) |
void | GetElem (uint32 index, T *&data) |
void | GetElem (uint32 index, const T *&data) const |
boolean | AddElem (const T *data) |
boolean | InsertElem (uint32 index, const T *data) |
void | RemoveElem (uint32 index, uint32 count) |
void | RemoveElem (T *elemToRemove) |
uint32 | FindElem (const T *item) const |
uint32 | FindNullPointersSuffixStart (uint32 index) const |
boolean | CompactArray (void) |
Protected Member Functions |
boolean | ArrayAlloc (uint32 initialCount, uint32 initialSpace, uint32 initialGrowSize, boolean initialZeroMem) |
boolean | ArrayAllocFromBuffer (T **baseAddress, boolean inAquireMemory, uint32 elemCount, uint32 elemSpace) |
void | UpdateDataPointer (void) |
void | ZeroInternals (void) |
Protected Attributes |
uint32 | fElemCount |
| The number of elements in use.
|
uint32 | fElemSpace |
| The number of elements allocated (unconstructed).
|
uint32 | fArrayFlags |
| Flags that control the behavior of the array.
|
T ** | fArrayData |
| The memory block used by the array.
|
Detailed Description
template<class T>
class TMCPtrArray< T >
TMCPtrArray is an array used to store pointers to objects. The array does NOT own those objects, so when it is destroyed, they still live. To delete those objects, call DeleteAndRemoveAll()
Indexes to access the Array classes are ZERO based (array[0] gives you the first element)
Arrays grows dynamically as you add elements. For better efficiency, preallocate the number of elements you'll need (or use an estimation of the space if possible).
In eSmartGrow mode (the default), the size of the extra space added when the array is reallocated (the grow size) depends on the number of elements already in the array. Otherwise, a constant grow size is used.
Other array classes are: TMCArray, TMCCountedPtrArray, TMCClassArray and TMCExtensibleArray.
Member Typedef Documentation
Declare iterator types for this array
The template type on which the array is based.
Constructor & Destructor Documentation
A type that represents the data type stored in the array.
Creates an empty array
Constructs an array with a certain number of elements already accessible
- Parameters:
-
| initialCount | initial number of array elements. |
| initialZeroMem | Zero the memory allocated for array storage ? |
Constructs an array with a certain number of elements already accessible, and/or some extra space to extend the array without reallocating it.
- Note:
- This constructor turns off eSmartGrow, so the grow size is constant
- Parameters:
-
| initialCount | Initial number of array elements. |
| initialSpace | Pre-allocate space for this many elements (must be bigger than initialCount). |
| initialGrowSize | How many elements to grow the array when we grow past the end |
| initialZeroMem | Zero the memory allocated for array storage ? |
Copy constructor: Construct an array from an existing array.
Copy constructor: Construct an array from an existing array.
Constructs an array from existing memory.
- Note:
- : If you pass inAquireMemory = false then this array CANNOT grow past elemSpace, and will not free the memory passed in.
- Parameters:
-
| baseAddress | External memory to use for this array. |
| inAquireMemory | Should we take possession this memory. |
| elemCount | The number of array elements in use in that memory. |
| elemSpace | The number of array elements that can be used in that memory. |
Constructs an alias to an existing array.
- Note:
- : This array CANNOT grow past elemSpace, and will not free the memory passed in. Also this array is an alias to the array passed in NOT a copy so be carefull.
- Parameters:
-
| array | Alias elements from this array. |
| elemStart | Start alias here. |
| elemCount | Alias this many elements. |
Member Function Documentation
Add an element to the end of the array and assign it the data reference that is passed in.
Add the passed in number of elemens to the array.
Append one array on to the end of another.
template<class T>
T** const TMCPtrArray< T >::ArrayData |
( |
void |
|
) |
const [inline] |
Returns a pointer to the first element
Returns a pointer to the first element
Frees all the memory held by this array (unless it uses external memory). And sets the element count to 0.
Returns the address at which the elements of the array begin
Returns the address at which the elements of the array begin
Returns an iterator initialized to the begining of the array.
Returns an iterator initialized to the begining of the array.
Gets rid of any space that has been allocated to the array and isn't being used.
Copy elements from one array to another.
Deletes all the objects referenced by the array and then removes them from the array.
Deletes some of the objects referenced by the array and then removes them from the array.
- Parameters:
-
| startIndex | index of the first elem to delete and remove |
| deleteCount | number of elements to delete and remove |
Returns an iterator initialized to the end of the array.
Returns an iterator initialized to the end of the array.
Erases a range of elements in the array from the startIterator to the endIterator.
Erases a single element in the array that is referenced by the iterator.
Returns true if the array doesn't own its memory
template<class T>
void TMCPtrArray< T >::FillWithValue |
( |
const T * |
inValue, |
|
|
uint32 |
inStart = kBeginIndex , |
|
|
uint32 |
inLength = kUnusedIndex | |
|
) |
| | [inline] |
Fill an array range with the value passed in.
Finds the index in this array of the given element
- Parameters:
-
| item | the element to search for |
- Returns:
- kUnusedIndex if elemToFind is not in the array, otherwise a valid index
Find the first index of the suffix contianing the indexed pointer for which all pointers are NULL
- Parameters:
-
| index | The index to start the search from |
- Returns:
- the index of the first index in this block for which all pointers onwards are NULL, or kUnusedIndex if there are not NULL pointers after this pointer.
template<class T>
const T* const TMCPtrArray< T >::FirstElem |
( |
void |
|
) |
const [inline] |
Returns a reference to the first element in the array.
Returns a reference to the first element in the array.
Get the contents of array index into the passed in data reference.
Get the contents of array index into the passed in data reference.
Returns the actual number of (valid) elements in the array. Those elements can be accessed with the operator []
Returns the size of one element (sizeof(T*))
Returns the number of elements that can be stored in the array (before the next reallocation)
Returns the size by which the array grows
Returns true if the grow size is dynamic
Returns true if the newly allocated memory should be initialized with zero
Insert one element into the array and assign the resulting item(s) the data data reference that is passed in.
IsValid(): Check to see if the class is valid.
template<class T>
const T* const TMCPtrArray< T >::LastElem |
( |
void |
|
) |
const [inline] |
Returns a reference to the last element in the array.
Returns a reference to the last element in the array.
operator=: Assignment operator copies all the pointers from one array to another.
operator=: Assignment operator copies all the pointers from one array to another.
Returns a reference to the data at the passed in index.
Returns a reference to the data at the passed in index.
Returns a pointer to the data at the passed in index.
Returns a pointer to the data at the passed in index.
template<class T>
template<class TArray2 >
void TMCPtrArray< T >::QueryArray |
( |
const MCIID & |
iid, |
|
|
TArray2 & |
outArray | |
|
) |
| | const [inline] |
template<class T>
void TMCPtrArray< T >::RemoveElem |
( |
T * |
elemToRemove |
) |
[inline] |
Remove one instance of elemToRemove if it exists in the array.
Removes one or more elements from the array starting from the passed in index.
Set the contents of array index to the passed in data reference.
Set the number of elements in the array.
Set the number of elements to have memory allocated for.
- Note:
- : This memory is unconstructed, uninitialied and isn't considered part of the array until the element count reaches the memory.
Sets the growSize (and sets the eSmartGrow flag to false)
Sets the eSmartGrow flag and computes the maximum grow size (in elements count)
Sets the valid flag to true
Sets whether the newly allocated memory should be initialized with zero
Swaps the contents of two arrays.
template<class T>
void TMCPtrArray< T >::UpdateDataPointer |
( |
void |
|
) |
[inline, protected] |
template<class T>
void TMCPtrArray< T >::ZeroInternals |
( |
void |
|
) |
[inline, protected] |
Member Data Documentation
The memory block used by the array.
Flags that control the behavior of the array.
The number of elements in use.
The number of elements allocated (unconstructed).
The documentation for this class was generated from the following file: