Class energy

Class that measures the energy spent when executing a section of code.

Hierarchy (view full)

Constructors

constructor

Properties

filename print printUnit

Methods

getPrintUnit measure measureValidate setPrint setPrintUnit

Constructors

constructor

  • new energy(filename?): energy

  • Parameters

    • Optionalfilename: string

    Returns energy

Properties

filename

filename: undefined | string

print

print: boolean

printUnit

printUnit: boolean

Methods

getPrintUnit

measure

ProtectedmeasureValidate

  • measureValidate($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

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

    Returns boolean

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

setPrint

  • setPrint(print): this

  • Parameters

    • print: boolean

    Returns this

setPrintUnit

  • setPrintUnit(printUnit): this

  • If true, suffixes 'J' to the end of the value.

    Parameters

    • printUnit: boolean

    Returns this

Settings

Member Visibility

On This Page

Constructors
Properties
Methods