Main Page | Packages | Class Tree | Index | Help

xp.util

class TimeInterval

Object
  |
  +--xp.util.TimeInterval


class TimeInterval
extends Object

An object representing a Timer Interval


Author:
ProWin Computers Ltd. - Rob Edgar

Version:
3.0.0.000

See also:


Field Summary

public
days: Number
time interval in days

public
endTime: Date
the end date object

public
hours: Number
time interval in hours

public
interval: Number
the interval this object represents

public
maxDimension: Number
the maximum time dimension

public
milliseconds: Number
time interval in milliseconds

public
minutes: Number
time interval in minutes

public
seconds: Number
time interval in seconds

public
startTime: Date
the start date obejct

Method Summary

public
calculateInterval ( )
recalculates the interval based on the end and start times

public
setTimeInterval ( interval: Number )
directly sets the interval

public
setTimes ( start: Date, end: Date )
directly sets end and start times

public
update ( )
update the all the fields with the time interval



Field Documentation

days

public var days: Number
time interval in days

endTime

public var endTime: Date
the end date object

hours

public var hours: Number
time interval in hours

interval

public var interval: Number
the interval this object represents

maxDimension

public var maxDimension: Number
the maximum time dimension

this controls the max reporting dimension. One of 4=days,3-hours,2-minutes,1-seconds,0-milliseconds. If the interval is say 50hrs and the maximum dimension is set to hours then the interval will be calculated as hours with hours =50 and days=0 If max dimension was days then days=2 hours=2;

milliseconds

public var milliseconds: Number
time interval in milliseconds

minutes

public var minutes: Number
time interval in minutes

seconds

public var seconds: Number
time interval in seconds

startTime

public var startTime: Date
the start date obejct


Method Documentation

calculateInterval

public function calculateInterval()
recalculates the interval based on the end and start times

setTimeInterval

public function setTimeInterval(interval: Number)
directly sets the interval

setTimes

public function setTimes(start: Date,
 end: Date)
directly sets end and start times

update

public function update()
update the all the fields with the time interval


The documentation was generated from the following file:


Generated on 10/30/2005 9:34:02 PM by AS2Doc