Class timerBase<T>Abstract

Timer object, for timing sections of code.

Type Parameters

Hierarchy

  • timerBase

    Constructors

    constructor

    Properties

    filename print printUnit timeUnits

    Methods

    _timeValidate getAfterJp getUnit setAfterJp setPrint setPrintUnit time

    Constructors

    constructor

    Properties

    filename

    filename: undefined | string

    Protectedprint

    print: boolean = true

    ProtectedprintUnit

    printUnit: boolean = true

    timeUnits

    timeUnits: timeUnits

    Methods

    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
      • functionJpName: string = "function"

      Returns boolean

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

    getAfterJp

    getUnit

    setAfterJp

    setPrint

    setPrintUnit

    Abstracttime

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

    • Times the code of a given section.

      Parameters

      • $start: T

        Starting point of the time measure

      • Optionalprefix: string

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

      • Optional$end: T

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

      Returns undefined | string

      Name of the variable that contains the value of the elapsed time.

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods