rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlTimeUnitHour Class Reference

Hour time unit. More...

#include <ilog/date.h>

Inheritance diagram for IlTimeUnitHour:
IlTimeUnit

List of all members.

Public Member Functions

 IlTimeUnitHour ()
 Constructor.
virtual void addTimeUnit (IlCalendar &cal) const
 Increments the given IlCalendar date by 1 hour.
virtual IlTimeUnitcopy () const
 Return a IlTimeUnitHour.
virtual IlDouble getMillis () const
 returns the duration of this time unit in milliseconds.
virtual void snapToPreviousTimeUnit (IlCalendar &cal) const
 Snaps the given IlCalendar</code date to the last hour.
virtual char * toString (IlDate date) const
 Returns a string representing the date in hours.

Detailed Description

Hour time unit.

Library: ilog

See also:
IlvTimeScaleStepsUpdater

Member Function Documentation

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

Increments the given IlCalendar date by 1 hour.

Add 1 hour to cal.

Parameters:
cal The date to change.

Implements IlTimeUnit.

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

Return a IlTimeUnitHour.

Returns:
a IlTimeUnitHour.

Implements IlTimeUnit.

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

Snaps the given IlCalendar</code date to the last hour.

Sets cal minutes, seconds and milliseconds to 0.

Parameters:
cal The date to change.

Implements IlTimeUnit.

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

Returns a string representing the date in hours.

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

Returns:
a string in the "HH:MN" format (e.g. "13:45")
Parameters:
date : the date to convert.

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