IlPredefinedUnits Class Reference

Utility class holding all time units. More...

#include <ilog/date.h>

Public Member Functions
IlTimeUnit *	getNextUnit ()
	Gets the next unit in the array. More...
IlTimeUnit *	operator[] (IlUInt i)
	Returns a IlTimeUnit from the array. More...
void	reset ()
	Ensure getNextUnit returns the first unit. More...

Static Public Member Functions
static unsigned int	nbUnits ()
	Returns the number of units in the array. More...

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.

Returns

The next unit in the array.

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 is greater than or equal to nbUnits().

See also

nbUnits().

void IlPredefinedUnits::reset

(

)

Ensure getNextUnit returns the first unit.

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

See also

getNextUnit().