rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlTimeUnitWeek Class Reference

Week time unit. More...

#include <ilog/date.h>

Inheritance diagram for IlTimeUnitWeek:
IlTimeUnit

List of all members.

Public Member Functions

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

Detailed Description

Week time unit.

Library: ilog

See also:
IlvTimeScaleStepsUpdater

Member Function Documentation

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

Increments the given IlCalendar date by 1 week.

Add 1 week to cal.

Parameters:
cal The date to change.

Implements IlTimeUnit.

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

Return a IlTimeUnitWeek.

Returns:
a IlTimeUnitWeek.

Implements IlTimeUnit.

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

Snaps the given IlCalendar date to the last week.

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

Parameters:
cal The date to change.

Implements IlTimeUnit.

virtual char* IlTimeUnitWeek::toString ( IlDate  date  )  const [virtual]

Returns a string representing the date in weeks.

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

Parameters:
date : the date to convert
Returns:
a string of the "Wn" format, 'n' being the week of the year (e.g. "W12").

© 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.