Class EnergyBase<T>

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

Type Parameters

T extends LaraJoinPoint

Hierarchy (View Summary)

EnergyBase
- Energy
- Energy

Index

Constructors

Properties

filename print printUnit

Methods

getPrintUnit measureValidate setPrint setPrintUnit

Constructors

constructor

new EnergyBase<T extends LaraJoinPoint>(filename?: string): EnergyBase<T>
Type Parameters
- T extends LaraJoinPoint
Parameters
- Optionalfilename: string
Returns EnergyBase<T>
- Defined in lara-framework/Lara-JS/src-api/lara/code/EnergyBase.ts:11

Properties

filename

filename: string | undefined

print

print: boolean = true

printUnit

printUnit: boolean = true

Methods

getPrintUnit

getPrintUnit(): string
Returns string
- Defined in lara-framework/Lara-JS/src-api/lara/code/EnergyBase.ts:24

`Protected`measureValidate

measureValidate($start?: any, $end?: any, functionJpName?: string): 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
- functionJpName: string = "function"
Returns boolean
True if $start is a valid join point for the 'measure' function
- Defined in lara-framework/Lara-JS/src-api/lara/code/EnergyBase.ts:46

setPrint

setPrint(print: boolean): EnergyBase<T>
Parameters
- print: boolean
Returns EnergyBase<T>
- Defined in lara-framework/Lara-JS/src-api/lara/code/EnergyBase.ts:28

setPrintUnit

setPrintUnit(printUnit: boolean): EnergyBase<T>
If true, suffixes 'J' to the end of the value.
Parameters
- printUnit: boolean
Returns EnergyBase<T>
- Defined in lara-framework/Lara-JS/src-api/lara/code/EnergyBase.ts:19