FunctionTimer (Artisynth API documentation)

java.lang.Object
- maspack.util.FunctionTimer

```
public class FunctionTimer
extends java.lang.Object
```
Class to measure the elapsed time between events, as marked by calls to the start and stop methods. Mainly intended for use in timing the execution speed of functions.

Constructor Summary

Constructors
Constructor and Description

FunctionTimer()
Create a new FunctionTimer

Constructors
Constructor and Description
`FunctionTimer()` Create a new FunctionTimer

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`averageTime()` Returns a string describing the average time, as returned by `getAverageTimeUsec()`.
`double`	`getAverageTimeUsec()` Returns the total time divided by the cycle count, in microseconds.
`int`	`getCycleCount()` Returns the total number of record cycles (`start()` followed by `stop()`, with possible `restart()` calls in between) since the timer was created or `reset()` was last called.
`double`	`getResolutionUsec()` Returns the resolution of this timer, in microseconds.
`double`	`getTimeUsec()` Returns the elapsed time in microseconds.
`double`	`getTotalTimeUsec()` Returns the sum of all the elapsed times measured (in microseconds) since the timer was created or `reset()` was last called.
`void`	`reset()` Sets the elapsed time, total time and cycle count to 0 and re-initializes the start indicator.
`void`	`restart()` Marks the beginning of a new timing interval and leaves the elapsed time unchanged.
`java.lang.String`	`result(int cnt)` Returns a string describing the current elapsed time, divided by the supplied count parameter.
`java.lang.String`	`resultMsec(int cnt)` Returns a string describing the current elapsed time, divided by the supplied count parameter.
`java.lang.String`	`resultUsec(int cnt)` Returns a string describing the current elapsed time, divided by the supplied count parameter.
`void`	`start()` Marks the beginning of a new timing interval and sets the elapsed time to 0.
`void`	`stop()` Adds the time difference between the current time and the last time `start` or `restart` was called to the elapsed time.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - FunctionTimer
```
public FunctionTimer()
```
    Create a new FunctionTimer
- Method Detail
  - start
```
public void start()
```
    Marks the beginning of a new timing interval and sets the elapsed time to 0.
  - restart
```
public void restart()
```
    Marks the beginning of a new timing interval and leaves the elapsed time unchanged.
  - reset
```
public void reset()
```
    Sets the elapsed time, total time and cycle count to 0 and re-initializes the start indicator.
  - stop
```
public void stop()
```
    Adds the time difference between the current time and the last time start or restart was called to the elapsed time. If start was not previously called, no change is made to the elapsed time.
  - getTimeUsec
```
public double getTimeUsec()
```
    Returns the elapsed time in microseconds.
    If the timer is running (i.e., start or restart has been called but stop has not yet been called, the associated time difference will not be included in the result.
    
    Returns:
    
    elapsed time
  - getTotalTimeUsec
```
public double getTotalTimeUsec()
```
    Returns the sum of all the elapsed times measured (in microseconds) since the timer was created or reset() was last called.
    If the timer is running (i.e., start or restart has been called but stop has not yet been called, the associated time difference will not be included in the result.
    
    Returns:
    
    total time
  - getCycleCount
```
public int getCycleCount()
```
    Returns the total number of record cycles (start() followed by stop(), with possible restart() calls in between) since the timer was created or reset() was last called.
    
    Returns:
    
    cycle count
  - getAverageTimeUsec
```
public double getAverageTimeUsec()
```
    Returns the total time divided by the cycle count, in microseconds. See getTotalTimeUsec() and getCycleCount().
    
    Returns:
    
    average time
  - getResolutionUsec
```
public double getResolutionUsec()
```
    Returns the resolution of this timer, in microseconds. This depends on the system calls available for measuring time.
    
    Returns:
    
    timer resolution
  - result
```
public java.lang.String result(int cnt)
```
    Returns a string describing the current elapsed time, divided by the supplied count parameter. The resulting divided time is displayed in milliseconds, unless it is less than 1 millisecond, in which case it is displayed in microseconds.
    
    Parameters:
    
    cnt - count to divide the elapsed time by
    
    Returns:
    
    string describing the divdied time
  - averageTime
```
public java.lang.String averageTime()
```
    Returns a string describing the average time, as returned by getAverageTimeUsec(). The result is displayed in milliseconds, unless it is less than 1 millisecond, in which case it is displayed in microseconds.
    
    Returns:
    
    string describing the average time
  - resultUsec
```
public java.lang.String resultUsec(int cnt)
```
    Returns a string describing the current elapsed time, divided by the supplied count parameter. The resulting divided time is displayed in microseconds.
    
    Parameters:
    
    cnt - count to divide the elapsed time by
    
    Returns:
    
    string describing the divdied time
  - resultMsec
```
public java.lang.String resultMsec(int cnt)
```
    Returns a string describing the current elapsed time, divided by the supplied count parameter. The resulting divided time is displayed in milliseconds.
    
    Parameters:
    
    cnt - count to divide the elapsed time by
    
    Returns:
    
    string describing the divdied time

Class FunctionTimer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

FunctionTimer

Method Detail

start

restart

reset

stop

getTimeUsec

getTotalTimeUsec

getCycleCount

getAverageTimeUsec

getResolutionUsec

result

averageTime

resultUsec

resultMsec