Class TimeQuantity

This class provides a simple means for storing and calculating time quantities.

Hierarchy

TimeQuantity

Implements

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new TimeQuantity(_quantity?: number): TimeQuantity

- Defined in source/System/Time/TimeQuantity.ts:19
Parameters
- Default value _quantity: number = 0
Returns TimeQuantity

Properties

Protected _quantity

_quantity: number

Protected _total

_total: ITimeMeasurement

Accessors

direction

get direction(): number

- Defined in source/System/Time/TimeQuantity.ts:35
+1, 0, or -1 depending on the time direction.

Returns number

total

get total(): ITimeMeasurement

- Defined in source/System/Time/TimeQuantity.ts:68
Returns an object with all units exposed as totals.

Returns ITimeMeasurement

Methods

compareTo

compareTo(other: ITimeQuantity): number

- Defined in source/System/Time/TimeQuantity.ts:55
Compares this instance against any other time quantity instance.

Parameters
- other: ITimeQuantity
Returns number

equals

equals(other: ITimeQuantity): boolean

- Defined in source/System/Time/TimeQuantity.ts:45
Compares this instance against any other time quantity instance and return true if the amount of time is the same.

Parameters
- other: ITimeQuantity
Returns boolean

getTotal

getTotal(units: TimeUnit): number

- Defined in source/System/Time/TimeQuantity.ts:92
Returns the total amount of time measured in the requested TimeUnit.

Parameters
- units: TimeUnit
Returns number

getTotalMilliseconds

getTotalMilliseconds(): number

Implementation of ITimeQuantity.getTotalMilliseconds
- Defined in source/System/Time/TimeQuantity.ts:26
Returns number

Generated using TypeDoc