BunyipsLib/au.edu.sa.mbhs.studentrobotics.bunyipslib.executables/MovingAverageTimer

MovingAverageTimer

open class MovingAverageTimer : Runnable

Time utilities for robot operation. Source

Author

Shaun, 11/06/2017

Since

1.0.0-pre

Constructors

MovingAverageTimer

constructor()

Create a new MovingAverageTimer with a ring buffer size of 100 and a resolution of milliseconds.

constructor(bufSize: Int)

Create a new MovingAverageTimer with the specified buffer size and a resolution of milliseconds.

constructor(bufSize: Int, @NonNull formatStringResolution: Time)

Create a new MovingAverageTimer with the specified buffer size and resolution.

Properties

FLIGHT_RECORDER_INTERVAL_MS

open var FLIGHT_RECORDER_INTERVAL_MS: Long

The minimum interval at which to auto-log loop time data to the FlightRecorder.

Functions

averageLoopTime

@NonNull

open fun averageLoopTime(): Measure<Time>

deltaTime

@NonNull

open fun deltaTime(): Measure<Time>

elapsedTime

@NonNull

open fun elapsedTime(): Measure<Time>

loopCount

open fun loopCount(): Long

loopsPer

open fun loopsPer(@NonNull unit: Time): Double

maxAverageLoopTime

@NonNull

open fun maxAverageLoopTime(): Measure<Time>

maxLoopTime

@NonNull

open fun maxLoopTime(): Measure<Time>

maxMovingAverageLoopTime

@NonNull

open fun maxMovingAverageLoopTime(): Measure<Time>

minAverageLoopTime

@NonNull

open fun minAverageLoopTime(): Measure<Time>

minLoopTime

@NonNull

open fun minLoopTime(): Measure<Time>

minMovingAverageLoopTime

@NonNull

open fun minMovingAverageLoopTime(): Measure<Time>

movingAverageLoopTime

@NonNull

open fun movingAverageLoopTime(): Measure<Time>

recordOnChannel

open fun recordOnChannel(channel: String)

Periodically records loop time data to the FlightRecorder.

reset

open fun reset()

Reset the timer.

run

open fun run()

toString

@NonNull

open fun toString(): String

update

open fun update()

Update the timer.