IlTimeUnitYear Class Reference

Year time unit. More...

#include <ilog/date.h>

Inheritance diagram for IlTimeUnitYear:

List of all members.

Public Member Functions
	IlTimeUnitYear ()
	Constructor.
virtual void	addTimeUnit (IlCalendar &cal) const
	Increments the given IlCalendar date by 1 year.
virtual IlTimeUnit *	copy () const
	Return a IlTimeUnitYear.
virtual IlDouble	getMillis () const
	returns the duration of this time unit in milliseconds.
virtual void	snapToPreviousTimeUnit (IlCalendar &cal) const
	Snaps the given IlCalendar date to the last year.
virtual char *	toString (IlDate date) const
	Returns a string representing the date in years.

---

Detailed Description

Year time unit.

Library: ilog

See also:

IlvTimeScaleStepsUpdater

---

Member Function Documentation

virtual void IlTimeUnitYear::addTimeUnit

(

IlCalendar &

cal

)

const [virtual]

Increments the given IlCalendar date by 1 year.

Add 1 year to cal.

Parameters:

cal

The date to change.

Implements IlTimeUnit.

virtual IlTimeUnit* IlTimeUnitYear::copy

(

)

const [virtual]

Return a IlTimeUnitYear.

Returns:

a IlTimeUnitYear.

Implements IlTimeUnit.

virtual IlDouble IlTimeUnitYear::getMillis

(

)

const [virtual]

returns the duration of this time unit in milliseconds.

Returns the duration of this time unit in milliseconds.

Implements IlTimeUnit.

virtual void IlTimeUnitYear::snapToPreviousTimeUnit

(

IlCalendar &

cal

)

const [virtual]

Snaps the given IlCalendar date to the last year.

Sets cal to the first day of the year at 00:00.

Parameters:

cal

The date to change.

Implements IlTimeUnit.

virtual char* IlTimeUnitYear::toString

(

IlDate

date

)

const [virtual]

Returns a string representing the date in years.

Returns an allocated string which should be deleted with delete[].

Parameters:

date

: the date to convert.

Returns:

a string representing the year of the date (e.g. "2001").