rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Static Public Member Functions
IlvTimeUtil Class Reference

Utility class for dealing with dates and calendars. More...

#include <ilviews/graphics/timescale.h>

Static Public Member Functions

static IlDate add (IlDate date, IlvDuration delta)
 Returns a new IlDate that is the sum of the specified date and duration. More...
 
static void dayFloor (IlCalendar &calendar)
 Truncates the given IlCalendar downwards to the nearest day boundary. More...
 
static void halfDayFloor (IlCalendar &calendar)
 Truncates the given IlCalendar downwards to the nearest half-day or AM-PM boundary. More...
 
static void hourFloor (IlCalendar &calendar)
 Truncates the given IlCalendar downwards to the nearest hour boundary. More...
 
static void minuteFloor (IlCalendar &calendar)
 Truncates the given IlCalendar downwards to the nearest minute boundary. More...
 
static void monthFloor (IlCalendar &calendar)
 Truncates the given IlCalendar downwards to the nearest month boundary. More...
 
static IlDate subtract (IlDate date, IlvDuration delta)
 Returns a new IlDate that is the specified date minus the specified duration. More...
 
static void weekFloor (IlCalendar &calendar)
 Truncates the given IlCalendar downwards to the nearest week boundary. More...
 
static void yearFloor (IlCalendar &calendar)
 Truncates the given IlCalendar downwards to the nearest year boundary. More...
 

Detailed Description

Utility class for dealing with dates and calendars.

Library: views

This class holds a number of static methods that are of general use when working with IlDate and IlCalendar

Member Function Documentation

static IlDate IlvTimeUtil::add ( IlDate  date,
IlvDuration  delta 
)
static

Returns a new IlDate that is the sum of the specified date and duration.

Parameters
dateThe date.
deltaThe duration to add to the date.
static void IlvTimeUtil::dayFloor ( IlCalendar calendar)
static

Truncates the given IlCalendar downwards to the nearest day boundary.

Parameters
calendarThe calendar.
static void IlvTimeUtil::halfDayFloor ( IlCalendar calendar)
static

Truncates the given IlCalendar downwards to the nearest half-day or AM-PM boundary.

Parameters
calendarThe calendar.
static void IlvTimeUtil::hourFloor ( IlCalendar calendar)
static

Truncates the given IlCalendar downwards to the nearest hour boundary.

Parameters
calendarThe calendar.
static void IlvTimeUtil::minuteFloor ( IlCalendar calendar)
static

Truncates the given IlCalendar downwards to the nearest minute boundary.

Parameters
calendarThe calendar.
static void IlvTimeUtil::monthFloor ( IlCalendar calendar)
static

Truncates the given IlCalendar downwards to the nearest month boundary.

Parameters
calendarThe calendar.
static IlDate IlvTimeUtil::subtract ( IlDate  date,
IlvDuration  delta 
)
static

Returns a new IlDate that is the specified date minus the specified duration.

Parameters
dateThe date.
deltaThe duration to subtract from the date.
static void IlvTimeUtil::weekFloor ( IlCalendar calendar)
static

Truncates the given IlCalendar downwards to the nearest week boundary.

Parameters
calendarThe calendar.
static void IlvTimeUtil::yearFloor ( IlCalendar calendar)
static

Truncates the given IlCalendar downwards to the nearest year boundary.

Parameters
calendarThe calendar.

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