Class SampledTimer`Internal`

A timer that stores the last n samples in a ring buffer.

Hierarchy

SimpleTimer
- SampledTimer

Index

Constructors

constructor

new SampledTimer(statistics, name): SampledTimer
Creates a SampledTimer instance. Must still be added to statistics if it should be logged!
Parameters
- statistics: Statistics
  
  Statistics to use for management.
- name: string
  
  Name of the timer. Use colons to build a hierarchy.
Returns SampledTimer
Overrides SimpleTimer.constructor
- Defined in @xyzmaps/harp-mapview/lib/Statistics.ts:400

Properties

maxNumSamples

maxNumSamples: number = 1000

Maximum samples until the statistics are reset and updated, which may destroy a median computation.

`Readonly` name

name: string

Name of the timer. Use colons to build a hierarchy.

numResets

numResets: number = 0

The number of times the timer has reset.

running

running: boolean = false

true if timer has been started.

samples

samples: RingBuffer<number> = ...

The array of sampled values, its length cannot exceed maxNumSamples.

statistics

statistics: Statistics

Statistics to use for management.

Accessors

value

get value(): undefined | number
Gets the latest measurement. This function may return undefined if no measurement was done.

Returns undefined | number
Inherited from SimpleTimer.value
- Defined in @xyzmaps/harp-mapview/lib/Statistics.ts:238

Methods

getStats

getStats(): undefined | Stats
Updates the min, max, avg, and median values. Currently, this function is expensive, as it requires a copy of the sampled values.

Returns undefined | Stats
- Defined in @xyzmaps/harp-mapview/lib/Statistics.ts:433

now

now(): number
Samples the timer. Requires that the timer has started.

Returns number
the current timer value; -1 if statistics are disabled.
Inherited from SimpleTimer.now
- Defined in @xyzmaps/harp-mapview/lib/Statistics.ts:297

reset

reset(): void
Resets the timer and clears all of its historical values.

Returns void
Overrides SimpleTimer.reset
- Defined in @xyzmaps/harp-mapview/lib/Statistics.ts:408

setValue

setValue(val): void
Add a single measurement to the sample.
Parameters
- val: undefined | number
  
  A measurement to add.
Returns void
Overrides SimpleTimer.setValue
- Defined in @xyzmaps/harp-mapview/lib/Statistics.ts:421

start

start(): number
Starts the timer. Returns the current time, based on Performance.now().

Returns number
Inherited from SimpleTimer.start
- Defined in @xyzmaps/harp-mapview/lib/Statistics.ts:262

stop

stop(): number
Stops the timer. Requires that the timer has started.

Returns number
Inherited from SimpleTimer.stop
- Defined in @xyzmaps/harp-mapview/lib/Statistics.ts:276

Class SampledTimerInternal

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

statistics: Statistics

name: string

Returns SampledTimer

Properties

maxNumSamples

Readonly name

numResets

running

samples

statistics

Accessors

value

Returns undefined | number

Methods

getStats

Returns undefined | Stats

now

Returns number

reset

Returns void

setValue

Parameters

val: undefined | number

Returns void

start

Returns number

stop

Returns number

Settings

Member Visibility

Theme

On This Page

Class SampledTimer`Internal`

`Readonly` name