rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlTimeUnitMonth Class Reference

Month time unit. More...

#include <ilog/date.h>

Inheritance diagram for IlTimeUnitMonth:
IlTimeUnit

List of all members.

Public Member Functions

 IlTimeUnitMonth ()
 Constructor.
virtual void addTimeUnit (IlCalendar &cal) const
 Increments the given IlCalendar date by 1 month.
virtual IlTimeUnitcopy () const
 Return a IlTimeUnitMonth.
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 month.
virtual char * toString (IlDate date) const
 Returns a string representing the date in months.

Detailed Description

Month time unit.

Library: ilog

See also:
IlvTimeScaleStepsUpdater

Member Function Documentation

virtual void IlTimeUnitMonth::addTimeUnit ( IlCalendar cal  )  const [virtual]

Increments the given IlCalendar date by 1 month.

Add 1 month to cal.

Parameters:
cal The date to change.

Implements IlTimeUnit.

virtual IlTimeUnit* IlTimeUnitMonth::copy (  )  const [virtual]

Return a IlTimeUnitMonth.

Returns:
a IlTimeUnitMonth.

Implements IlTimeUnit.

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.

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:
cal The date to change.

Implements IlTimeUnit.

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:
date : the date to convert.
Returns:
a string of the "MM/YY" format (e.g. "03/2001" for March 2001).

© Copyright 2012, 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.