NiTE 2.0: nite::Array< T > Class Template Reference

NiTE 2.0

nite::Array< T > Class Template Reference

#include <NiTE.h>

List of all members.

Public Member Functions

 Array ()
int getSize () const
bool isEmpty () const
const T & operator[] (int index) const
void setData (int size, T *data)

Detailed Description

template<class T>
class nite::Array< T >

Provides a simple array class used throughout the API. Wraps a primitive array of objects, holding the elements and their count.


Constructor & Destructor Documentation

template<class T>
nite::Array< T >::Array ( ) [inline]

Default constructor. Creates an empty Array and sets the element count to zero.


Member Function Documentation

template<class T>
int nite::Array< T >::getSize ( ) const [inline]

Getter function for the Array size.

Returns:
Current number of elements in the Array.
template<class T>
bool nite::Array< T >::isEmpty ( ) const [inline]

Check if there are any elements in the Array

Returns:
true if there are elements in the Array, false otherwise.
template<class T>
const T& nite::Array< T >::operator[] ( int  index) const [inline]

Implements the array indexing operator for the Array class

template<class T>
void nite::Array< T >::setData ( int  size,
T *  data 
) [inline]

Setter function for data. Causes this Array to wrap an existing primitive array of specified type.

Parameters:
[in]TType of objects the Array will contain
[in]dataPointer to first object in list
[in]sizeNumber of objects in list

The documentation for this class was generated from the following file:
Generated on Thu Jun 6 2013 17:48:15 for NiTE 2.0 by   doxygen 1.7.5.1