Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions
IlTimeUnitMonth Class Reference

Month time unit. More...

#include <ilog/date.h>

Inheritance diagram for IlTimeUnitMonth:
IlTimeUnit

Public Member Functions

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

Detailed Description

Month time unit.

Library: ilog

See also
IlvTimeScaleStepsUpdater.

Member Function Documentation

§ addTimeUnit()

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

Increments the given IlCalendar date by 1 month.

Adds 1 month to date.

Parameters
dateThe date to change.

Implements IlTimeUnit.

§ copy()

virtual IlTimeUnit* IlTimeUnitMonth::copy ( ) const
virtual

Returns an IlTimeUnitMonth.

Returns
A new IlTimeUnitMonth.

Implements IlTimeUnit.

§ getMillis()

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

Snaps the given IlCalendar date to the last month.

Sets cal to the first day of the month, at 00:00.

Parameters
calThe date to change.

Implements IlTimeUnit.

§ toString()

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

Returns a string representing the date in months.

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

Parameters
dateThe date to convert.
Returns
A string of the "MM/YY" format (e.g. "03/2001" for March 2001).

Implements IlTimeUnit.


© Copyright 2018, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.