ADTF
|
Multi dimensional index class used to dynamically address elements in a multi array. More...
Public Member Functions | |
cMultiArrayIndex () | |
Constructor that initializes the index to an invalid state. | |
cMultiArrayIndex (tUInt nX) | |
Constructor that initializes the index to a single dimension value. More... | |
cMultiArrayIndex (tUInt nX, tUInt nY) | |
Constructor that initializes the index to 2 dimension values. More... | |
cMultiArrayIndex (tUInt nX, tUInt nY, tUInt nZ) | |
Constructor that initializes the index to 3 dimension values. More... | |
cMultiArrayIndex (tUInt nX, tUInt nY, tUInt nZ, tUInt nT) | |
Constructor that initializes the index to 4 dimension values. More... | |
cMultiArrayIndex (tUInt nX, tUInt nY, tUInt nZ, tUInt nT, tUInt nR) | |
Constructor that initializes the index to 4 dimension values. More... | |
tBool | IsValid () const |
Check if the index is valid. More... | |
tResult | AddDimension (tUInt nDimensionValue) |
Add a dimension value to the index. More... | |
tResult | GetDimensionValue (tUInt nDimensionIndex, tUInt &nValue) const |
Get the value of the specified dimension. More... | |
tResult | SetDimensionValue (tUInt nDimensionIndex, tUInt nValue) |
Set the value of the specified dimension. More... | |
tSize | NumDimensions () const |
Get the number of dimensions. More... | |
Protected Attributes | |
std::vector< tUInt > | m_oDimensionvalues |
Stores the dimensional values. | |
Multi dimensional index class used to dynamically address elements in a multi array.
It is also used (see typedef to cMultiArrayDimensions) to represent the dimensions
It basically just dynamically stores a number of values for the dimensions
Definition at line 22 of file multiarray.h.
|
explicit |
Constructor that initializes the index to a single dimension value.
nX | [in] The first dimension value |
cMultiArrayIndex | ( | tUInt | nX, |
tUInt | nY | ||
) |
Constructor that initializes the index to 2 dimension values.
nX | [in] The first dimension value |
nY | [in] The second dimension value |
cMultiArrayIndex | ( | tUInt | nX, |
tUInt | nY, | ||
tUInt | nZ | ||
) |
Constructor that initializes the index to 3 dimension values.
nX | [in] The first dimension value |
nY | [in] The second dimension value |
nZ | [in] The third dimension value |
cMultiArrayIndex | ( | tUInt | nX, |
tUInt | nY, | ||
tUInt | nZ, | ||
tUInt | nT | ||
) |
Constructor that initializes the index to 4 dimension values.
nX | [in] The first dimension value |
nY | [in] The second dimension value |
nZ | [in] The third dimension value |
nT | [in] The fourth dimension value |
Constructor that initializes the index to 4 dimension values.
nX | [in] The first dimension value |
nY | [in] The second dimension value |
nZ | [in] The third dimension value |
nT | [in] The fourth dimension value |
nR | [in] The fifth dimension value |
Add a dimension value to the index.
nDimensionValue | [in] The new dimension value |
Get the value of the specified dimension.
nDimensionIndex | [in] The index of the dimension |
nValue | [out] Destination parameter for the value |
Referenced by cMultiArray< T >::CalculateInternIndex(), cMultiArray< T >::ContainsIndex(), and cMultiArray< T >::InitializeDataStore().
tBool IsValid | ( | ) | const |
Check if the index is valid.
Referenced by cMultiArray< T >::CalculateInternIndex(), cMultiArray< T >::ContainsIndex(), cMultiArray< T >::Get(), cMultiArray< T >::IsValid(), and cMultiArray< T >::Set().
tSize NumDimensions | ( | ) | const |
Get the number of dimensions.
Referenced by cMultiArray< T >::CalculateInternIndex(), cMultiArray< T >::ContainsIndex(), and cMultiArray< T >::InitializeDataStore().