core/timer

Duration Measuring Support

Dependency Graph

core/timer: Library Dependencies

View the full-size SVG (svg) or PDF (pdf) image or graphviz source (dot)

View color source code (raw) for this file

View reStructuredText (rst) source code for this page

Timer Value

timer_now()

Prints the current time with nanoseconds.

Timer Variables

timer_var_running()

Prints name of variable that stores a boolean value indicating the running state of the given timer ($1).

timer_var_start()

Prints name of variable that stores the starting time of the given timer ($1).

timer_var_final()

Prints name of variable that stores the final time of the given timer ($1).

timer_var_marks()

Prints name of an array variable that stores marks for the given timer ($1).

Timer Mark Interface

A timer mark is defined as the time an event occurred while the timer is running. This interface does not enforce any policy regarding the frequency, number, values, or ordering of marks. They simply must be valid time values formatted in the same manner as output by timer_now(). Their meaning is left to the user.

timer_mark()

Saves a new mark ($2) for the given timer ($1).

$1 - Name of timer.

$2 - Mark time. If null, obtains the current Timer Value.

timer_mark_all()

Prints the list of marks for the given timer ($1).

$1 - Name of timer.

timer_mark_count()

Prints the number of marks for the given timer ($1).

$1 - Name of timer.

timer_mark_first()

Prints the first mark for the given timer ($1).

$1 - Name of timer.

timer_mark_get()

Prints the mark at the given index ($2) for the given timer ($1).

$1 - Name of timer.

$2 - Index into mark array.

timer_mark_measure()

Computes and prints the difference between two marks ($2 and $3) for the given timer ($1).

$1 - Name of timer.

$2 - First index into timer mark array.

$3 - Second index into timer mark array.

Timer Lap Interface

A timer lap is defined as the elapsed interval between two succesive

timer marks. Thus, `n saved marks will calculate n

1` lap intervals.

timer_laps()

Prints the number of extant laps for the given timer ($1).

$1 - Name of timer.

timer_has_laps()

Checks the number of extant laps for the given timer ($1).

$1 - Name of timer.

Returns: Succcess if the timer has recorded at least one lap.

timer_lap_measure()

Prints the elapsed time between two marks ($2 and $3) for the given timer ($1).

$1 - Name of timer.

$2 - First index into timer mark array.

$3 - Second index into timer mark array.

timer_lap_measure()

Prints the last lap interval for the given timer ($1).

$1 - Name of timer

Timer Query

timer_is_exists()

Checks to see if the given timer ($1) exists.

$1 - Name of timer

Returns: Success if the timer exists.

timer_is_running()

Checks to see if the given timer ($1) is running.

$1 - Name of timer

Returns: Success if the timer is running.

timer_running()

Sets the running state ($2) for the given timer ($1).

$1 - Name of timer

$2 - New running state (true or false)

Timer Control

timer_start()

Stops the given timer ($1)

$1 - Name of timer

timer_stop()

Stops the given timer ($1)

$1 - Name of timer

Timer Reporting

timer_elapsed()

Prints a human readable version of the elapsed time for the given timer ($1).

$1 - Name of timer

timer_elapsed_seconds()

Prints the total number of elapsed seconds with nanosecond resolution.

$1 - Name of timer


View the Developer Guide Index

View the Reference Manual Index


Generated on Fri Jul 28 14:37:20 PDT 2017 by mcsh d14 v0.23.0.