IlTimeUnitYear Class Reference

Year time unit. More...

#include <ilog/date.h>

Inheritance diagram for IlTimeUnitYear:

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

Detailed Description

Year time unit.

Library: ilog

See also

IlvTimeScaleStepsUpdater.

Member Function Documentation

addTimeUnit()

virtual void IlTimeUnitYear::addTimeUnit ( IlCalendar &  date ) const

virtual

Increments the given IlCalendar date by 1 year.

Adds 1 year to date.

Parameters

date	The date to change.

Implements IlTimeUnit.

copy()

virtual IlTimeUnit* IlTimeUnitYear::copy ( ) const

virtual

Returns an IlTimeUnitYear.

Returns

A new IlTimeUnitYear.

Implements IlTimeUnit.

getMillis()

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.

snapToPreviousTimeUnit()

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.

toString()

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").

Implements IlTimeUnit.