Class Energy

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

Hierarchy (View Summary)

EnergyBase<Joinpoint>
- Energy

Index

Constructors

Properties

filename print printUnit

Methods

getPrintUnit measure measureValidate setPrint setPrintUnit

Constructors

constructor

new Energy(filename?: string): Energy
Parameters
- Optionalfilename: string
Returns Energy
Inherited from EnergyBase.constructor
- Defined in lara-framework/Lara-JS/api/lara/code/EnergyBase.d.ts:9

Properties

filename

filename: string | undefined

print

print: boolean

printUnit

printUnit: boolean

Methods

getPrintUnit

getPrintUnit(): string
Returns string
Inherited from EnergyBase.getPrintUnit
- Defined in lara-framework/Lara-JS/api/lara/code/EnergyBase.d.ts:15

measure

measure($start: Joinpoint, prefix: string, $end: Joinpoint): void
Parameters
- $start: Joinpoint
- prefix: string
- $end: Joinpoint
Returns void
- Defined in kadabra/Kadabra-JS/src-api/lara/code/Energy.ts:11

`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
- OptionalfunctionJpName: string
Returns boolean
True if $start is a valid join point for the 'measure' function
Inherited from EnergyBase.measureValidate
- Defined in lara-framework/Lara-JS/api/lara/code/EnergyBase.d.ts:26

setPrint

setPrint(print: boolean): this
Parameters
- print: boolean
Returns this
Inherited from EnergyBase.setPrint
- Defined in lara-framework/Lara-JS/api/lara/code/EnergyBase.d.ts:16

setPrintUnit

setPrintUnit(printUnit: boolean): this
If true, suffixes 'J' to the end of the value.
Parameters
- printUnit: boolean
Returns this
Inherited from EnergyBase.setPrintUnit
- Defined in lara-framework/Lara-JS/api/lara/code/EnergyBase.d.ts:14