Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions
IlTimeUnitDay Class Reference

Day time unit. More...

#include <ilog/date.h>

Inheritance diagram for IlTimeUnitDay:
IlTimeUnit

Public Member Functions

 IlTimeUnitDay ()
 Constructor.
 
virtual void addTimeUnit (IlCalendar &date) const
 Increments the given IlCalendar date by 1 day. More...
 
virtual IlTimeUnitcopy () const
 Returns an IlTimeUnitDay. 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 day. More...
 
virtual char * toString (IlDate date) const
 Returns a string representing the date in days. More...
 
- Public Member Functions inherited from IlTimeUnit
 IlTimeUnit ()
 Constructor.
 

Detailed Description

Day time unit.

Library: ilog

See also
IlvTimeScaleStepsUpdater.

Member Function Documentation

◆ addTimeUnit()

virtual void IlTimeUnitDay::addTimeUnit ( IlCalendar date) const
virtual

Increments the given IlCalendar date by 1 day.

Adds 1 day to date.

Parameters
dateThe date to change.

Implements IlTimeUnit.

◆ copy()

virtual IlTimeUnit* IlTimeUnitDay::copy ( ) const
virtual

Returns an IlTimeUnitDay.

Returns
A new IlTimeUnitDay.

Implements IlTimeUnit.

◆ getMillis()

virtual IlDouble IlTimeUnitDay::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 IlTimeUnitDay::snapToPreviousTimeUnit ( IlCalendar cal) const
virtual

Snaps the given IlCalendar date to the last day.

Sets cal hours, minutes, seconds and milliseconds to 0.

Parameters
calThe date to change.

Implements IlTimeUnit.

◆ toString()

virtual char* IlTimeUnitDay::toString ( IlDate  date) const
virtual

Returns a string representing the date in days.

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

Parameters
dateThe date to convert.
Returns
A string in the "DD/MM" format (e.g. 01/12 for dec. 1st).

Implements IlTimeUnit.