vona.time

Class TimeMetrics

java.lang.Object

vona.time.TimeMetrics

Direct Known Subclasses:

PDLS.TimeMetrics, SynchronizedTimeMetrics

public class TimeMetrics
extends java.lang.Object

Utility to collect temporal execution metrics of a repetitive task.

Copyright (C) 2007 Marsette A. Vona, III

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Author:

Marsette (Marty) A. Vona, III

Field Summary

Fields

Modifier and Type	Field and Description
int	count Number of executions
private static java.lang.String	cvsid
boolean	highRes whether to count in us (default) or ns (high resolution)
int	lastStartTime Most recent execution start time in us (ns if highRes)
int	lastTime Most recent execution time in us (ns if highRes)
int	maxTime Maximum execution time in us (ns if highRes)
int	minTime Minimum execution time in us (ns if highRes) or 0 if count 0
java.lang.String	name Name for these metrics
protected boolean	running whether a start has been marked without a matching end
long	totalTime Total execution time in us (ns if highRes)

Constructor Summary

Constructors

Constructor and Description
TimeMetrics(java.lang.String name) Covers TimeMetrics(String, boolean), not high res.
TimeMetrics(java.lang.String name, boolean highRes) calls reset()

Method Summary

Methods

Modifier and Type	Method and Description
float	averageMS() get averageTime() in milliseconds
int	averageTime() compute avg execution time from totalTime and count
void	dump(java.io.PrintStream s) Covers dump(PrintStream, int, boolean), always annotated and 0 name width.
void	dump(java.io.PrintStream s, int nameWidth) covers dump(PrintStream, int, boolean), always annotated
void	dump(java.io.PrintStream s, int nameWidth, boolean annotated) Dump human-readable metrics.
static void	dumpHeader(java.io.PrintStream s, int nameWidth, boolean annotated) dump a header line in fmt of dump(PrintStream, int, boolean)
int	getCurrentTime() get the current time in us (ns if highRes)
boolean	isRunning() check if the start has been marked but not the end
float	lastMS() get lastTime in milliseconds
void	markEnd() Mark the end of a task execution.
void	markStart() Mark the start of a task execution.
void	reset() Resets all metrics
float	toMS() get multiplicative conversion factor taking time values to ms

Methods inherited from class java.lang.Object

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

Field Detail

cvsid

private static final java.lang.String cvsid

See Also:

Constant Field Values

minTime

public int minTime

Minimum execution time in us (ns if highRes) or 0 if count 0

maxTime

public int maxTime

Maximum execution time in us (ns if highRes)

totalTime

public long totalTime

Total execution time in us (ns if highRes)

lastTime

public int lastTime

Most recent execution time in us (ns if highRes)

lastStartTime

public int lastStartTime

Most recent execution start time in us (ns if highRes)

count

public int count

Number of executions

name

public final java.lang.String name

Name for these metrics

highRes

public final boolean highRes

whether to count in us (default) or ns (high resolution)

running

protected boolean running

whether a start has been marked without a matching end

Constructor Detail

TimeMetrics

public TimeMetrics(java.lang.String name,
           boolean highRes)

calls reset()

TimeMetrics

public TimeMetrics(java.lang.String name)

Covers TimeMetrics(String, boolean), not high res.

Method Detail

averageTime

public int averageTime()

compute avg execution time from totalTime and count

averageMS

public float averageMS()

get averageTime() in milliseconds

lastMS

public float lastMS()

get lastTime in milliseconds

toMS

public float toMS()

get multiplicative conversion factor taking time values to ms

reset

public void reset()

Resets all metrics

getCurrentTime

public int getCurrentTime()

get the current time in us (ns if highRes)

markStart

public void markStart()

Mark the start of a task execution.

The task will be considered running (see isRunning()) until the next call to markEnd().

It is ok to call this even if the metrics are already running.

markEnd

public void markEnd()

Mark the end of a task execution.

It is ok to call this even if the metrics are not currently running.

isRunning

public boolean isRunning()

check if the start has been marked but not the end

dump

public void dump(java.io.PrintStream s,
        int nameWidth,
        boolean annotated)

Dump human-readable metrics.

Parameters:

nameWidth - min width of the name field, or non-positive for no limit

annotated - whether to show per-number annotations

dump

public void dump(java.io.PrintStream s,
        int nameWidth)

covers dump(PrintStream, int, boolean), always annotated

dump

public void dump(java.io.PrintStream s)

Covers dump(PrintStream, int, boolean), always annotated and 0 name width.

dumpHeader

public static void dumpHeader(java.io.PrintStream s,
              int nameWidth,
              boolean annotated)

dump a header line in fmt of dump(PrintStream, int, boolean)