IlPredefinedUnits Class Reference

Utility class holding all time units. More...

#include <ilog/date.h>

List of all members.

Public Member Functions
IlTimeUnit *	getNextUnit ()
	Gets the next unit in the array.
IlTimeUnit *	operator[] (IlUInt i)
	Returns a IlTimeUnit from the array.
void	reset ()
	Ensure getNextUnit returns the 1st unit.
Static Public Member Functions
static unsigned int	nbUnits ()
	Returns the number of units in the array.

---

Detailed Description

Utility class holding all time units.

Library: ilog

IlPredefinedUnits is used by IlvTimeScaleStepsUpdater::autoComputeUnit() to cycle through all possible units for a data set.

See also:

IlTimeUnit

---

Member Function Documentation

IlTimeUnit* IlPredefinedUnits::getNextUnit

(

)

Gets the next unit in the array.

If the last unit has been reached, it keeps returning that last unit.

static unsigned int IlPredefinedUnits::nbUnits

(

)

[static]

Returns the number of units in the array.

Returns:

the number of units in the array.

IlTimeUnit* IlPredefinedUnits::operator[]

(

IlUInt

i

)

Returns a IlTimeUnit from the array.

Parameters:

i

The index of the unit in the array.

Returns:

the unit, or an undefined result if i >= nbUnits().

See also:

nbUnits

void IlPredefinedUnits::reset

(

)

Ensure getNextUnit returns the 1st unit.

Reset the internal unit counter so that the next call to getNextUnit will return the first predefined IlTimeUnit.

See also:

getNextUnit