template<class T> class PBaseArray

This template class maps the PAbstractArray to a specific element type.

Inheritance:


Public Methods

[more] Construction
[more] Overrides from class PObject
[more] Overrides from class PContainer
[more] New functions for class


Inherited from PAbstractArray:

Protected Fields

oPINDEX elementSize
ochar* theArray
oBOOL allocatedDynamically


Inherited from PContainer:

Public Methods

Common functions for containers

Protected Methods

ovirtual void DestroyContents()
ovirtual void AssignContents(const PContainer & c)
ovoid CopyContents(const PContainer & c)
ovoid CloneContents(const PContainer* src)
ovoid Destruct()


Inherited from PObject:

Public Methods

Run Time Type functions

I/O functions

Miscellaneous functions

Public Members

Comparison functions


Documentation

This template class maps the PAbstractArray to a specific element type. The functions in this class primarily do all the appropriate casting of types.

Note that if templates are not used the PBASEARRAY macro will simulate the template instantiation.

The following classes are instantiated automatically for the basic scalar types:

o Construction

o PBaseArray( PINDEX initialSize = 0 )
Construct a new dynamic array of elements of the specified type. The array is initialised to all zero bytes. Note that this may not be logically equivalent to the zero value for the type, though this would be very rare.
Parameters:
initialSize - Initial number of elements in the array.

o PBaseArray( T const* buffer, PINDEX length, BOOL dynamic = TRUE )
Construct a new dynamic array of elements of the specified type.
Parameters:
- buffer Pointer to an array of the elements of type T.
length - Number of elements pointed to by buffer.
dynamic - Buffer is copied and dynamically allocated.

o Overrides from class PObject

ovirtual PObject* Clone() const
Clone the object

o Overrides from class PContainer

oBOOL SetAt( PINDEX index, T val )
Set the specific element in the array. The array will automatically expand, if necessary, to fit the new element in.

Parameters:
index - Position in the array to set the new value.
val - Value to set in the array.
Returns:
TRUE if new memory for the array was successfully allocated.

oT GetAt( PINDEX index ) const
Get a value from the array. If the index is beyond the end of the allocated array then a zero value is returned.

Parameters:
index - Position on the array to get value from.
Returns:
value at the array position.

ovoid Attach( const T* buffer, PINDEX bufferSize )
Attach a pointer to a static block to the base array type. The pointer is used directly and will not be copied to a dynamically allocated buffer. If the SetSize() function is used to change the size of the buffer, the object will be converted to a dynamic form with the contents of the static buffer copied to the allocated buffer.

Any dynamically allocated buffer will be freed.

Parameters:
- buffer Pointer to an array of elements.
- bufferSize Number of elements pointed to by buffer.

oT* GetPointer( PINDEX minSize = 0 )
Get a pointer to the internal array and assure that it is of at least the specified size. This is useful when the array contents are being set by some external or system function eg file read.

It is unsafe to assume that the pointer is valid for very long after return from this function. The array may be resized or otherwise changed and the pointer returned invalidated. It should be used for simple calls to atomic functions, or very careful examination of the program logic must be performed.

Parameters:
minSize - Minimum size for returned buffer pointer.
Returns:
pointer to the array memory.

o New functions for class

oT operator[]( PINDEX index ) const
Get a value from the array. If the index is beyond the end of the allocated array then a zero value is returned.

This is functionally identical to the PContainer::GetAt() function.

Parameters:
index - Position on the array to get value from.
Returns:
value at the array position.

oT& operator[]( PINDEX index )
Get a reference to value from the array. If the index is beyond the end of the allocated array then the array is expanded. If a memory allocation failure occurs the function asserts.

This is functionally similar to the SetAt() function and allows the array subscript to be an lvalue.

Parameters:
index - Position on the array to get value from.
Returns:
reference to value at the array position.

o operator T const *() const
Get a pointer to the internal array. The user may not modify the contents of this pointer/ This is useful when the array contents are required by some external or system function eg file write.

It is unsafe to assume that the pointer is valid for very long after return from this function. The array may be resized or otherwise changed and the pointer returned invalidated. It should be used for simple calls to atomic functions, or very careful examination of the program logic must be performed.

Returns:
constant pointer to the array memory.

oBOOL Concatenate( const PBaseArray & array )
Concatenate one array to the end of this array. This function will allocate a new array large enough for the existing contents and the contents of the parameter. The paramters contents is then copied to the end of the existing array.

Note this does nothing and returns FALSE if the target array is not dynamically allocated.

Parameters:
array - Other array to concatenate
Returns:
TRUE if the memory allocation succeeded.


Direct child classes:
PDWORDArray
PUnsignedArray
PWORDArray
PBYTEArray
PLongArray
PIntArray
PShortArray
PScalarArray
PCharArray

Alphabetic index HTML hierarchy of classes or Java



This page was generated with the help of DOC++.