burlap.debugtools

Class MyTimer

java.lang.Object

burlap.debugtools.MyTimer

public class MyTimer
extends java.lang.Object

A data structure for keeping track of elapsed and average time. Use start() to start the timer (or set it to start in the constructor MyTimer(boolean). Use peekAtTime() to check the current elapsed time since it was started. Use stop() to stop the timer and getTime() to get the elapsed time between the last time the timer was started and stopped. If you start and stop the timer multiple times, you can get the average time for all start-stops using the getAvgTime() method and the total time of all start-stops with getTotalTime(). If you want to check if the timer is running, use isRunning().

Author:

James MacGlashan

Constructor Summary

Constructors

Constructor and Description
MyTimer() Creates a new timer.
MyTimer(boolean start) Creates a new timer and starts it if start=true.

Method Summary

Modifier and Type	Method and Description
double	getAvgTime() Returns the average time in seconds recorded over all start-stop calls.
double	getTime() Returns the elapsed time in seconds since the last start-stop calls.
double	getTotalTime() Returns the total time in seconds recorded over all start-stop calls.
boolean	isRunning() Indicates whether this timer is currently running.
static void	main(java.lang.String[] args) Demo of usage
double	peekAtTime() Returns the current elapsed time since the timer was started.
void	resetAvgs() Resets to zero the average and total time recorded over all start-stop calls.
boolean	start() Starts the timer if it is not running.
boolean	stop() Stops the timer.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MyTimer

public MyTimer()

Creates a new timer. Timing will not yet be started.

MyTimer

public MyTimer(boolean start)

Creates a new timer and starts it if start=true.

Parameters:

start - if true, then start the timer; if false then don't start the timer.

Method Detail

main

public static void main(java.lang.String[] args)

Demo of usage

Parameters:

args - command line args

start

public boolean start()

Starts the timer if it is not running.

Returns:

returns true if the timer is started; false if it is already running and cannot be started.

stop

public boolean stop()

Stops the timer. Has no effect is the timer has not been started.

Returns:

returns true if stops the timer; false if the timer is not running and cannot be stopped.

isRunning

public boolean isRunning()

Indicates whether this timer is currently running.

Returns:

true if the timer is running; false if it is not.

getTime

public double getTime()

Returns the elapsed time in seconds since the last start-stop calls. The returned value is not well defined if the timer has not been started and stopped at least once. If you want the elapsed time while it's running, use peekAtTime().

Returns:

the elapsed time in seconds since the last start-stop calls.

peekAtTime

public double peekAtTime()

Returns the current elapsed time since the timer was started. Returns 0 if the timer is not running.

Returns:

The current elapsed time since the timer was started or 0 if the timer is not running.

getAvgTime

public double getAvgTime()

Returns the average time in seconds recorded over all start-stop calls.

Returns:

the average time in seconds recorded over all start-stop calls.

getTotalTime

public double getTotalTime()

Returns the total time in seconds recorded over all start-stop calls.

Returns:

the total time in seconds recorded over all start-stop calls.

resetAvgs

public void resetAvgs()

Resets to zero the average and total time recorded over all start-stop calls.