#include <Array.h>

Inheritance diagram for PLCore::Array< ValueType >:

Public Member Functions
	Array (uint32 nMaxNumOfElements=0, bool bAdded=true, bool bInit=false)
	Constructor.
	Array (const Array< ValueType > &lstSource, uint32 nStart=0, uint32 nCount=0)
	Copy constructor.
	Array (const Container< ValueType > &lstSource, uint32 nStart=0, uint32 nCount=0)
	Copy constructor.
virtual	~Array ()
	Destructor.
Container< ValueType > &	operator= (const Array< ValueType > &lstSource)
	Copy operator.
uint32	GetMaxNumOfElements () const
	Returns the maximum number of elements in the array.
bool	Resize (uint32 nMaxNumOfElements, bool bAdded=true, bool bInit=false)
	Sets the maximum number of elements in the array.
uint32	GetResizeCount () const
	Returns the number of elements automatically added if the array size is to small.
bool	SetResizeCount (uint32 nCount=10)
	Sets the number of elements automatically added if the array size is to small.
ValueType *	GetData () const
	Returns the array data.
void	Reset ()
	Resets the array.
void	MoveElement (uint32 nFromIndex, uint32 nToIndex)
	Moves an element within the array.
virtual Iterator< ValueType >	GetIterator (uint32 nIndex=0) const override
	Returns an iterator operating on the derived data structure.
virtual ConstIterator< ValueType >	GetConstIterator (uint32 nIndex=0) const override
	Returns a constant iterator operating on the derived data structure.
virtual Iterator< ValueType >	GetEndIterator () const override
	Returns an iterator operating on the derived data structure and starting at the end.
virtual ConstIterator< ValueType >	GetConstEndIterator () const override
	Returns a constant iterator operating on the derived data structure and starting at the end.
virtual bool	IsEmpty () const override
	Checks whether the container is complete empty.
virtual uint32	GetNumOfElements () const override
	Returns the number of elements.
virtual uint32	GetElementSize () const override
	Returns the size of a single container element (in bytes)
virtual uint32	GetSize () const override
	Returns the total size of all container elements (in bytes)
virtual void	Clear () override
	Clears the whole container.
virtual bool	IsElement (const ValueType &Element) const override
	Returns whether the given element is within the container or not.
virtual int	GetIndex (const ValueType &Element) const override
	Returns the index of an element (first appearance)
virtual ValueType &	Get (uint32 nIndex) const override
	Returns an element.
virtual ValueType &	operator[] (uint32 nIndex) const override
	Returns an element.
virtual bool	Replace (const ValueType &Element1, const ValueType &Element2) override
	Replaces an element (first appearance) through another element.
virtual bool	ReplaceAtIndex (uint32 nIndex, const ValueType &Element) override
	Replaces an element at the given index through another element.
virtual ValueType &	Add () override
	Appends an element to the container.
virtual ValueType &	Add (const ValueType &Element) override
	Appends an element to the container.
virtual uint32	Add (const ValueType *pElements, uint32 nCount) override
	Adds elements from a given C-array.
virtual Container< ValueType > &	operator+= (const ValueType &Element) override
	Appends an element to the container.
virtual bool	Add (const Container< ValueType > &lstContainer, uint32 nStart=0, uint32 nCount=0) override
	Appends an container to this container.
virtual Container< ValueType > &	operator+= (const Container< ValueType > &lstContainer) override
	Appends an container to this container.
virtual ValueType &	AddAtIndex (int nIndex) override
	Appends an element to the container at the given index.
virtual ValueType &	AddAtIndex (const ValueType &Element, int nIndex) override
	Appends an element to the container at the given index.
virtual bool	Remove (const ValueType &Element) override
	Removes an element (first appearance) from the container.
virtual bool	RemoveAtIndex (uint32 nElement) override
	Removes the element at the given index from the container.
virtual Container< ValueType > &	operator-= (const ValueType &Element) override
	Removes an element from the container.
virtual bool	Remove (const Container< ValueType > &lstContainer, uint32 nStart=0, uint32 nCount=0) override
	Removes the elements of an container from this container.
virtual Container< ValueType > &	operator-= (const Container< ValueType > &lstContainer) override
	Removes the elements of an container from this container.
virtual bool	Copy (const Container< ValueType > &lstContainer, uint32 nStart=0, uint32 nCount=0) override
	Makes this container to a copy of another container.
virtual Container< ValueType > &	operator= (const Container< ValueType > &lstContainer) override
	Makes this container to a copy of another container.
virtual bool	Compare (const Container< ValueType > &lstContainer, uint32 nStart=0, uint32 nCount=0) const override
	Compares two containers.
virtual bool	operator== (const Container< ValueType > &lstContainer) const override
	Compares two containers.
virtual bool	operator!= (const Container< ValueType > &lstContainer) const override
	Compares two containers.

Detailed Description

template<class ValueType>
class PLCore::Array< ValueType >

Array class.

Remarks:: Within the array, all elements will be arranged sequentially in memory. The array is resized automatically if required, in this case a new array is created internally, old data is copied and the old array is destroyed. Therefore, avoid array resizing if you have a lot of big elements. Using 'GetData()' you can receive a pointer to the first element, now you can iterate through the array using 'GetData()+1' etc. for more performance.

Note:

Do NOT backup pointer to array elements, if the array is resized they will become invalid

Constructor & Destructor Documentation

template<class ValueType >

PLCore::Array< ValueType >::Array	(	uint32	nMaxNumOfElements = `0`,
		bool	bAdded = `true`,
		bool	bInit = `false`
	)

Constructor.

Parameters:

[in]	nMaxNumOfElements	Maximum number of elements within the array
[in]	bAdded	Are all elements added? (GetNumOfElements() = GetMaxNumOfElements())
[in]	bInit	Initialize new elements by setting them to null?

See also:

Resize()

template<class ValueType>

PLCore::Array< ValueType >::Array	(	const Array< ValueType > &	lstSource,
		uint32	nStart = `0`,
		uint32	nCount = `0`
	)

Copy constructor.

Parameters:

[in]	lstSource	Array to copy from
[in]	nStart	Index the copy operation should start
[in]	nCount	Number of elements to copy, if 0 copy all elements of lstSource behind nStart

template<class ValueType>

PLCore::Array< ValueType >::Array	(	const Container< ValueType > &	lstSource,
		uint32	nStart = `0`,
		uint32	nCount = `0`
	)

Copy constructor.

Parameters:

[in]	lstSource	Container to copy from
[in]	nStart	Index the copy operation should start
[in]	nCount	Number of elements to copy, if 0 copy all elements of lstSource behind nStart

template<class ValueType >

PLCore::Array< ValueType >::~Array ( ) [virtual]

Destructor.

Member Function Documentation

template<class ValueType>

Container< ValueType > & PLCore::Array< ValueType >::operator= ( const Array< ValueType > & lstSource )

Copy operator.

Parameters:

[in] lstSource Array to copy from

Returns:: Reference to this instance

template<class ValueType >

uint32 PLCore::Array< ValueType >::GetMaxNumOfElements ( ) const

Returns the maximum number of elements in the array.

Returns:: Maximum number of element in the array

template<class ValueType >

bool PLCore::Array< ValueType >::Resize	(	uint32	nMaxNumOfElements,
		bool	bAdded = `true`,
		bool	bInit = `false`
	)

Sets the maximum number of elements in the array.

Sets the number of elements in the array.

Parameters:

[in]	nMaxNumOfElements	New maximum number of elements (0 = clear array)
[in]	bAdded	Are all elements added? (GetNumOfElements() = GetMaxNumOfElements())
[in]	bInit	Initialize new elements by setting them to null?

Returns:: 'true' if all went fine, else 'false'

Note:

In arrays with direct objects like Array<MyClass> which have some internal classes and especial virtual functions it's NOT recommended to set 'bInit' to true!

template<class ValueType >

uint32 PLCore::Array< ValueType >::GetResizeCount ( ) const

Returns the number of elements automatically added if the array size is to small.

Returns:: Number of elements automatically added if the array size is to small

template<class ValueType >

bool PLCore::Array< ValueType >::SetResizeCount ( uint32 nCount = 10 )

Sets the number of elements automatically added if the array size is to small.

Parameters:

[in] nCount Number of elements automatically added if the array size is to small

Returns:: 'true' if all went fine, else 'false'

Note:

If nCount is 0, the array size isn't changed automatically

template<class ValueType >

ValueType * PLCore::Array< ValueType >::GetData ( ) const

Returns the array data.

Returns:: The array data, can be a null pointer

Note:

Do NOT delete this data by yourself!
Do NOT mess up the memory by writing outside the given buffer...

template<class ValueType >

void PLCore::Array< ValueType >::Reset ( )

Resets the array.

Remarks:: While the Clear() function destroys also the data, this function will only reset the current number of elements within the array to 0.

template<class ValueType >

void PLCore::Array< ValueType >::MoveElement	(	uint32	nFromIndex,
		uint32	nToIndex
	)

Moves an element within the array.

Parameters:

[in]	nFromIndex	The index of the element which should be moved
[in]	nToIndex	The index to which the element should be moved

Note:

This methods assumes, that both index values are within 0 and GetNumOfElements()-1

template<class ValueType >

Iterator< ValueType > PLCore::Array< ValueType >::GetIterator ( uint32 nIndex = 0 ) const [override, virtual]

Returns an iterator operating on the derived data structure.

Parameters:

[in] nIndex Start index, if >= 'total number of elements' the index is set to the last valid index

Returns:: Iterator operating on the derived

Implements PLCore::Iterable< ValueType >.

template<class ValueType >

ConstIterator< ValueType > PLCore::Array< ValueType >::GetConstIterator ( uint32 nIndex = 0 ) const [override, virtual]

Returns a constant iterator operating on the derived data structure.

Parameters:

[in] nIndex Start index, if >= 'total number of elements' the index is set to the last valid index

Returns:: Constant iterator operating on the derived

Implements PLCore::Iterable< ValueType >.

template<class ValueType >

Iterator< ValueType > PLCore::Array< ValueType >::GetEndIterator ( ) const [override, virtual]

Returns an iterator operating on the derived data structure and starting at the end.

Returns:: Iterator operating on the derived,

Remarks:: Use this function to get an iterator if you want to iterate in reversed order starting at the end last element.

Implements PLCore::Iterable< ValueType >.

template<class ValueType >

ConstIterator< ValueType > PLCore::Array< ValueType >::GetConstEndIterator ( ) const [override, virtual]

Returns a constant iterator operating on the derived data structure and starting at the end.

Returns:: Constant iterator operating on the derived,

Remarks:: Use this function to get a constant iterator if you want to iterate in reversed order starting at the end last element.

Implements PLCore::Iterable< ValueType >.

template<class ValueType >

bool PLCore::Array< ValueType >::IsEmpty ( ) const [override, virtual]

Checks whether the container is complete empty.

Returns:: 'true' if the container is empty, else 'false'

Implements PLCore::Container< ValueType >.

template<class ValueType >

uint32 PLCore::Array< ValueType >::GetNumOfElements ( ) const [override, virtual]

Returns the number of elements.

Returns:: Number of container elements

Implements PLCore::Container< ValueType >.

template<class ValueType >

uint32 PLCore::Array< ValueType >::GetElementSize ( ) const [override, virtual]

Returns the size of a single container element (in bytes)

Returns:: Size of a single container element (in bytes)

Implements PLCore::Container< ValueType >.

template<class ValueType >

uint32 PLCore::Array< ValueType >::GetSize ( ) const [override, virtual]

Returns the total size of all container elements (in bytes)

Returns:: Total size of all container elements (in bytes)

Remarks:: You can NOT assume that GetElementSize()*GetNumOfElements() = GetSize() is always true. For instance the Bitset implementation will store the bits tightly packed and therefore in this case GetElementSize()*GetNumOfElements() != GetSize(). GetSize() will only give you a hind how many bytes are currently required to store all elements WITHOUT further implementation dependent things like pointers from one to the next element.

Implements PLCore::Container< ValueType >.

template<class ValueType >

void PLCore::Array< ValueType >::Clear ( ) [override, virtual]

Clears the whole container.

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::IsElement ( const ValueType & Element ) const [override, virtual]

Returns whether the given element is within the container or not.

Parameters:

[in] Element Element to check

Returns:: 'true' if the element is within the container, else 'false'

Implements PLCore::Container< ValueType >.

template<class ValueType>

int PLCore::Array< ValueType >::GetIndex ( const ValueType & Element ) const [override, virtual]

Returns the index of an element (first appearance)

Parameters:

[in] Element Element to get the index from

Returns:: Index of the given element, < 0 if it's not in the container

Implements PLCore::Container< ValueType >.

template<class ValueType >

ValueType & PLCore::Array< ValueType >::Get ( uint32 nIndex ) const [override, virtual]

Returns an element.

Parameters:

[in] nIndex Index of the element to return

Returns:: Reference to the element at the given index, reference to the 'Null'-object on error

Implements PLCore::Container< ValueType >.

template<class ValueType >

ValueType & PLCore::Array< ValueType >::operator[] ( uint32 nIndex ) const [override, virtual]

Returns an element.

Parameters:

[in] nIndex Index of the element to return

Returns:: Reference to the element at the given index, reference to the 'Null'-object on error

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::Replace	(	const ValueType &	Element1,
		const ValueType &	Element2
	)		`[override, virtual]`

Replaces an element (first appearance) through another element.

Parameters:

[in]	Element1	Element to replace
[in]	Element2	The element which should replace the old one

Returns:: 'true' if all went fine, else 'false' (maybe 'Element1' is not within the container?)

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::ReplaceAtIndex	(	uint32	nIndex,
		const ValueType &	Element
	)		`[override, virtual]`

Replaces an element at the given index through another element.

Parameters:

[in]	nIndex	Index of the element to replace
[in]	Element	The element which should replace the old one

Returns:: 'true' if all went fine, else 'false' (maybe invalid index?)

Implements PLCore::Container< ValueType >.

template<class ValueType >

ValueType & PLCore::Array< ValueType >::Add ( ) [override, virtual]

Appends an element to the container.

Returns:: Reference to the new element, reference to the 'Null'-object on error

Implements PLCore::Container< ValueType >.

template<class ValueType>

ValueType & PLCore::Array< ValueType >::Add ( const ValueType & Element ) [override, virtual]

Appends an element to the container.

Parameters:

[in] Element Element to add

Returns:: Reference to the new element, reference to the 'Null'-object on error

Implements PLCore::Container< ValueType >.

template<class ValueType>

uint32 PLCore::Array< ValueType >::Add	(	const ValueType *	pElements,
		uint32	nCount
	)		`[override, virtual]`

Adds elements from a given C-array.

Parameters:

[in]	pElements	Pointer to C-array with the elements to add, if a null pointer, nothing is done
[in]	nCount	Number of elements to add, the given C-array MUST have at least nCount elements!

Returns:: Number of added elements -> if the array is full and resizing is not allowed, this number may differ from the given nCount

Implements PLCore::Container< ValueType >.

template<class ValueType>

Container< ValueType > & PLCore::Array< ValueType >::operator+= ( const ValueType & Element ) [override, virtual]

Appends an element to the container.

Parameters:

[in] Element Element to add

Returns:: This container

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::Add	(	const Container< ValueType > &	lstContainer,
		uint32	nStart = `0`,
		uint32	nCount = `0`
	)		`[override, virtual]`

Appends an container to this container.

Parameters:

[in]	lstContainer	Container to add
[in]	nStart	Index the copy operation should start
[in]	nCount	Number of elements to copy, if 0 copy all elements of lstContainer behind nStart

Returns:: 'true' if all went fine, else 'false'

Implements PLCore::Container< ValueType >.

template<class ValueType>

Container< ValueType > & PLCore::Array< ValueType >::operator+= ( const Container< ValueType > & lstContainer ) [override, virtual]

Appends an container to this container.

Parameters:

[in] lstContainer Container to add

Returns:: This container

Implements PLCore::Container< ValueType >.

template<class ValueType >

ValueType & PLCore::Array< ValueType >::AddAtIndex ( int nIndex ) [override, virtual]

Appends an element to the container at the given index.

Parameters:

[in] nIndex Index were to add the new element, if < 0 add at end, must be <= 'GetNumOfElements()'

Returns:: Reference to the new element, reference to the 'Null'-object on error (maybe invalid index?)

Note:

If the given index is equal to 'GetNumOfElements()' the element is appended at the end of the container
The container is only enlarged by one element, this means that if 'GetNumOfElements()' is currently 0 and you give an index of 5 the container is NOT automatically resized to 6 elements!

Implements PLCore::Container< ValueType >.

template<class ValueType>

ValueType & PLCore::Array< ValueType >::AddAtIndex	(	const ValueType &	Element,
		int	nIndex
	)		`[override, virtual]`

Appends an element to the container at the given index.

Parameters:

[in]	Element	Element to add
[in]	nIndex	Index were to add the new element, if < 0 add at end, must be <= 'GetNumOfElements()'

Returns:: Reference to the new element, reference to the 'Null'-object on error (maybe invalid index?)

See also:

AddAtIndex() above

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::Remove ( const ValueType & Element ) [override, virtual]

Removes an element (first appearance) from the container.

Parameters:

[in] Element Element to remove

Returns:: 'true' if all went fine, else 'false' (maybe 'Element' is not within the container?)

Implements PLCore::Container< ValueType >.

template<class ValueType >

bool PLCore::Array< ValueType >::RemoveAtIndex ( uint32 nElement ) [override, virtual]

Removes the element at the given index from the container.

Parameters:

[in] nElement Index of the element to remove

Returns:: 'true' if all went fine, else 'false' (maybe invalid index?)

Implements PLCore::Container< ValueType >.

template<class ValueType>

Container< ValueType > & PLCore::Array< ValueType >::operator-= ( const ValueType & Element ) [override, virtual]

Removes an element from the container.

Parameters:

[in] Element Element to remove

Returns:: This container

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::Remove	(	const Container< ValueType > &	lstContainer,
		uint32	nStart = `0`,
		uint32	nCount = `0`
	)		`[override, virtual]`

Removes the elements of an container from this container.

Parameters:

[in]	lstContainer	Container to remove the elements from this container
[in]	nStart	Index the remove operation should start
[in]	nCount	Number of elements to remove, if 0 remove all elements of lstContainer behind nStart

Returns:: 'true' if all went fine, else 'false'

Implements PLCore::Container< ValueType >.

template<class ValueType>

Container< ValueType > & PLCore::Array< ValueType >::operator-= ( const Container< ValueType > & lstContainer ) [override, virtual]

Removes the elements of an container from this container.

Parameters:

[in] lstContainer Container to remove the elements from this container

Returns:: This container

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::Copy	(	const Container< ValueType > &	lstContainer,
		uint32	nStart = `0`,
		uint32	nCount = `0`
	)		`[override, virtual]`

Makes this container to a copy of another container.

Parameters:

[in]	lstContainer	Container to copy from
[in]	nStart	Index the copy operation should start
[in]	nCount	Number of elements to copy, if 0 copy all elements of lstContainer behind nStart

Returns:: 'true' if all went fine, else 'false'

Implements PLCore::Container< ValueType >.

template<class ValueType>

Container< ValueType > & PLCore::Array< ValueType >::operator= ( const Container< ValueType > & lstContainer ) [override, virtual]

Makes this container to a copy of another container.

Parameters:

[in] lstContainer Container to copy from

Returns:: Reference to this instance

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::Compare	(	const Container< ValueType > &	lstContainer,
		uint32	nStart = `0`,
		uint32	nCount = `0`
	)		const `[override, virtual]`

Compares two containers.

Parameters:

[in]	lstContainer	Container to compare with
[in]	nStart	Index the compare operation should start
[in]	nCount	Number of elements to compare, if 0 compare all elements of lstContainer behind nStart

Returns:: 'true' if both containers are equal, else 'false'

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::operator== ( const Container< ValueType > & lstContainer ) const [override, virtual]

Compares two containers.

Parameters:

[in] lstContainer Container to compare with

Returns:: 'true' if both containers are equal, else 'false'

Implements PLCore::Container< ValueType >.

template<class ValueType>

bool PLCore::Array< ValueType >::operator!= ( const Container< ValueType > & lstContainer ) const [override, virtual]

Compares two containers.

Parameters:

[in] lstContainer Container to compare with

Returns:: 'true' if both containers are not equal, else 'false'

Implements PLCore::Container< ValueType >.

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

Public Member Functions

Detailed Description

template<class ValueType> class PLCore::Array< ValueType >

Constructor & Destructor Documentation

Member Function Documentation

template<class ValueType>
class PLCore::Array< ValueType >