vona.time

Class SynchronizedTimeMetrics

java.lang.Object

vona.time.TimeMetrics

vona.time.SynchronizedTimeMetrics

public class SynchronizedTimeMetrics
extends TimeMetrics

TimeMetrics with an external synchronization object.

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
private static java.lang.String	cvsid
protected java.lang.Object	monitor an object on which to synchronize

Fields inherited from class vona.time.TimeMetrics

count, highRes, lastStartTime, lastTime, maxTime, minTime, name, running, totalTime

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
int	averageTime() compute avg execution time from TimeMetrics.totalTime and TimeMetrics.count
void	dump(java.io.PrintStream s, int nameWidth, boolean annotated) Dump human-readable metrics.
int	getCurrentTime() get the current time in us (ns if TimeMetrics.highRes)
boolean	isRunning() check if the start has been marked but not the end
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 vona.time.TimeMetrics

averageMS, dump, dump, dumpHeader, lastMS

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

monitor

protected final java.lang.Object monitor

an object on which to synchronize

Constructor Detail

SynchronizedTimeMetrics

public SynchronizedTimeMetrics(java.lang.String name,
                       boolean highRes,
                       java.lang.Object monitor)

calls TimeMetrics.reset()

SynchronizedTimeMetrics

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

Covers SynchronizedTimeMetrics(String, boolean, Object), no monitor.

SynchronizedTimeMetrics

public SynchronizedTimeMetrics(java.lang.String name,
                       java.lang.Object monitor)

Covers SynchronizedTimeMetrics(String, boolean, Object), not high res.

SynchronizedTimeMetrics

public SynchronizedTimeMetrics(java.lang.String name)

Covers SynchronizedTimeMetrics(String, boolean, Object), not high res, no monitor.

Method Detail

averageTime

public int averageTime()

compute avg execution time from TimeMetrics.totalTime and TimeMetrics.count

Overrides:

averageTime in class TimeMetrics

toMS

public float toMS()

get multiplicative conversion factor taking time values to ms

Overrides:

toMS in class TimeMetrics

reset

public void reset()

Resets all metrics

Overrides:

reset in class TimeMetrics

getCurrentTime

public int getCurrentTime()

get the current time in us (ns if TimeMetrics.highRes)

Overrides:

getCurrentTime in class TimeMetrics

markStart

public void markStart()

Mark the start of a task execution.

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

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

Overrides:

markStart in class TimeMetrics

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.

Overrides:

markEnd in class TimeMetrics

isRunning

public boolean isRunning()

check if the start has been marked but not the end

Overrides:

isRunning in class TimeMetrics

dump

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

Dump human-readable metrics.

Overrides:

dump in class TimeMetrics

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

annotated - whether to show per-number annotations