Class timer

Timer object, for timing sections of code.

Hierarchy (view full)

Constructors

constructor

Properties

addedDefines filename print printUnit timeUnits

Methods

_time_c _time_cpp _timeValidate getAfterJp getUnit setAfterJp setPrint setPrintUnit time

Constructors

constructor

  • new timer(unit?, filename?): timer

  • Parameters

    • Optionalunit: TimerUnit
    • Optionalfilename: string

    Returns timer

Properties

addedDefines

addedDefines: Set<string> = ...

filename

filename: undefined | string

Protectedprint

print: boolean

ProtectedprintUnit

printUnit: boolean

timeUnits

timeUnits: timeUnits

Methods

_time_c

_time_cpp

Protected_timeValidate

  • _timeValidate($start, $end?, functionJpName?): boolean

  • Verifies that join point start is not undefined, that it is inside a function. Additionally, if $end is not undefined, checks if it is inside the same function as $start.

    [Requires] global attribute 'ancestor'.

    Parameters

    • $start: any
    • Optional$end: any
    • OptionalfunctionJpName: string

    Returns boolean

    True if $start is a valid join point for the 'time' function

getAfterJp

  • getAfterJp(): undefined | Joinpoint

  • Returns undefined | Joinpoint

    The last join point that was inserted after the $end mark

getUnit

setAfterJp

  • setAfterJp($afterJp): void

  • Sets the join point that should be returned by .getAfterJp().

    Parameters

    Returns void

setPrint

  • setPrint(print): this

  • Parameters

    • print: boolean

    Returns this

setPrintUnit

  • setPrintUnit(printUnit): this

  • Parameters

    • printUnit: boolean

    Returns this

time

  • time($start, prefix?, $end?): undefined | string

  • Times the code of a given section.

    Parameters

    • $start: Joinpoint

      Starting point of the time measure

    • prefix: string = ""

      Message that will appear before the time measure. If undefined, empty string will be used.

    • $end: Joinpoint = $start

      Ending point of the time measure. If undefined, measure is done around starting point.

    Returns undefined | string

Settings

Member Visibility

On This Page

Constructors
Properties
Methods