System::Container< Ay > Class Template Reference

The base of all containers in the engine.

#include <Container.hpp>

Inheritance diagram for System::Container< Ay >:

System::Array< Ty, Ay > System::Array< CharTy > System::CharacterArray< CharTy >

List of all members.

Public Member Functions

size_type Size () const
 Returns the size of the container.
size_type Capacity () const
 Returns the capacity of the container.
pointer Data ()
 Returns a pointer to the data managed by the container.
const_pointer Data () const
 Returns a constant pointer to the data managed by the container.
size_type Add (size_type Count, size_type ElementSize)
 Adds a number of elements to the container, and returns an index to the beginning of the new elements.
size_type Add (size_type Count, size_type ElementSize, const_reference Value)
 Adds a number of elements to the container, initializes them with the specified value, and returns an index to the beginning of the new elements.
VOID Insert (size_type Index, size_type Count, size_type ElementSize)
 Inserts a number of elements starting from the specified index.
VOID Insert (size_type Index, size_type Count, size_type ElementSize, const_reference Value)
 Inserts a number of elements starting from the specified index, and initializes them with the specified value.
VOID Reserve (size_type Count, size_type ElementSize)
 Reserves a specified number of elements, allocating more if necessary.
VOID Resize (size_type Count, size_type ElementSize)
 Resizes the container to the specified count, with the input element size.
VOID Resize (size_type Count, size_type ElementSize, const_reference Value)
 Resizes the container to the specified count, with the input element size, and initializes each element with the specified value.
VOID Shrink (size_type ElementSize)
 Shrinks the container to the current size.
VOID Remove (size_type Index, size_type Count, size_type ElementSize)
 Remove a number of elements starting from the specified index.
VOID Clear (size_type ElementSize, size_type Capacity=0)
 All elements from the container are removed.
 Container ()
 Constructs an empty container.
 Container (size_type Count, size_type ElementSize)
 Constructs a container with the specified number of elements.
 Container (size_type Count, size_type ElementSize, const_reference Value)
 Constructs a container with the specified number of elements and initializes them with the specified value.
 Container (E_SkipInitialization)
 Skip container initialization.
 ~Container ()
 Frees any allocated memory.

Protected Attributes

pointer _Data
size_type _Size
size_type _Capacity

template<class Ay>
class System::Container< Ay >


Constructor & Destructor Documentation

template<class Ay>
System::Container< Ay >::Container ( size_type  Count,
size_type  ElementSize 
) [inline]

Parameters:
Count The number of elements to initialize the container with.
ElementSize The size of each element in the container.

template<class Ay>
System::Container< Ay >::Container ( size_type  Count,
size_type  ElementSize,
const_reference  Value 
) [inline]

Parameters:
Count The number of elements to initialize the container with.
ElementSize The size of each element in the container.
Value The value to initialize each element with.


Member Function Documentation

template<class Ay>
size_type System::Container< Ay >::Size (  )  const [inline]

Returns:
The size of the container.

template<class Ay>
size_type System::Container< Ay >::Capacity (  )  const [inline]

Returns:
The capacity of the container.

template<class Ay>
pointer System::Container< Ay >::Data (  )  [inline]

Returns:
Pointer to data managed by container.

template<class Ay>
const_pointer System::Container< Ay >::Data (  )  const [inline]

Returns:
Constant pointer to data managed by container.

template<class Ay>
size_type System::Container< Ay >::Add ( size_type  Count,
size_type  ElementSize 
) [inline]

Parameters:
Count The number of elements to add.
ElementSize The size of each element.
Returns:
The index of the beginning of the new elements.

template<class Ay>
size_type System::Container< Ay >::Add ( size_type  Count,
size_type  ElementSize,
const_reference  Value 
) [inline]

Parameters:
Count The number of elements to add.
ElementSize The size of each element.
Value The value to initialize new elements with.
Returns:
The index of the beginning of the new elements.

template<class Ay>
VOID System::Container< Ay >::Insert ( size_type  Index,
size_type  Count,
size_type  ElementSize 
) [inline]

Parameters:
Index The index where the elements will be inserted.
Count The number of elements to insert.
ElementSize The size of each element in the container.

template<class Ay>
VOID System::Container< Ay >::Insert ( size_type  Index,
size_type  Count,
size_type  ElementSize,
const_reference  Value 
) [inline]

Parameters:
Index The index where the elements will be inserted.
Count The number of elements to insert.
ElementSize The size of each element in the container.
Value The value to initialize each new element with.

template<class Ay>
VOID System::Container< Ay >::Reserve ( size_type  Count,
size_type  ElementSize 
) [inline]

Parameters:
Count The number of elements to reserve.
ElementSize The size of each element.

template<class Ay>
VOID System::Container< Ay >::Resize ( size_type  Count,
size_type  ElementSize 
) [inline]

Parameters:
Count The number of elements to resize the container to.
ElementSize The size of each element in the container.

template<class Ay>
VOID System::Container< Ay >::Resize ( size_type  Count,
size_type  ElementSize,
const_reference  Value 
) [inline]

Parameters:
Count The number of elements to resize the container to.
ElementSize The size of each element in the container.
Value The value to initialize new elements with.

template<class Ay>
VOID System::Container< Ay >::Shrink ( size_type  ElementSize  )  [inline]

Parameters:
ElementSize The size of each element in the container.

template<class Ay>
VOID System::Container< Ay >::Remove ( size_type  Index,
size_type  Count,
size_type  ElementSize 
) [inline]

Parameters:
Index The index at which to remove the elements.
Count The number of elements to remove.
ElementSize The size of each element in the container.

template<class Ay>
VOID System::Container< Ay >::Clear ( size_type  ElementSize,
size_type  Capacity = 0 
) [inline]

Parameters:
ElementSize The size of each element in the container.
Capacity The new capacity for the container.


Member Data Documentation

template<class Ay>
pointer System::Container< Ay >::_Data [protected]

The address of the data the container is managing.

template<class Ay>
size_type System::Container< Ay >::_Size [protected]

The size of the container.

template<class Ay>
size_type System::Container< Ay >::_Capacity [protected]

The capacity of the container.


The documentation for this class was generated from the following file:
Generated on Wed Dec 5 14:53:01 2007 for Aerospace Engine by  doxygen 1.5.3