com.partnersoft.system.performance

Class PerformanceClock

java.lang.Object

com.partnersoft.system.performance.PerformanceClock

public class PerformanceClock
extends java.lang.Object

Stopwatch integrated into the performance metering framework.

It is designed for simplicity and performance; you are responsible for thread safety and ensuring that starts and stops match properly.

Example of usage:

 clock = SystemServices.performance().createClockFor("coffee drinking");
 while (time < millerTime) {
     clock.start();
     drinkCoffee();
     clock.stop();
 }
 clock.updateMeter();
 

 Copyright 1998-2012 Partner Software, Inc.

Author:

Paul Reavis

Constructor Summary

Constructors

Constructor and Description
PerformanceClock(PerformanceMeter meter)

Method Summary

Methods

Modifier and Type	Method and Description
void	cycle() Bumps the cycle count; this is the same as a stop() followed by a start().
long	getCycles() Get the value of the counter.
double	getHertz() Get the cycles/sec.
long	getMilliseconds() Get the total time in milliseconds of all timing runs.
void	reset() Reset everything to zero.
void	start() Start the clock and begins a cycle.
void	stop() Stop the clock, ending the cycle and incrementing the cycle counter by one.
void	stop(long cycles) Stop the clock and increment the cycle counter by the given number of cycles.
void	stopAndUpdateMeter() Guess what this does? Three guesses only.
void	updateMeter() Send timing and counter data to this clock's meter.

Methods inherited from class java.lang.Object

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

Constructor Detail

PerformanceClock

public PerformanceClock(PerformanceMeter meter)

Method Detail

reset

public void reset()

Reset everything to zero. Only needed if you're reusing this clock.

start

public void start()

Start the clock and begins a cycle.

stop

public void stop()

Stop the clock, ending the cycle and incrementing the cycle counter by one.

stop

public void stop(long cycles)

Stop the clock and increment the cycle counter by the given number of cycles.

Use this if your start/stop combination encompasses multiple laps or runs or whatever you're timing.

updateMeter

public void updateMeter()

Send timing and counter data to this clock's meter.

stopAndUpdateMeter

public void stopAndUpdateMeter()

Guess what this does? Three guesses only.

cycle

public void cycle()

Bumps the cycle count; this is the same as a stop() followed by a start().

getMilliseconds

public long getMilliseconds()

Get the total time in milliseconds of all timing runs.

getCycles

public long getCycles()

Get the value of the counter.

getHertz

public double getHertz()

Get the cycles/sec.