Class TaskTimer

Creates a timed task, which will execute 'time' ms after invoking execute

Hierarchy

IntermediateTimer
- TaskTimer

Index

Constructors

Properties

$timerClass access filename name print printUnit timeUnits DEFAULT_CLASS_NAME

Methods

_timeValidate get getAfterJp getAndStart getUnit measure measureCode ready setAfterJp setPrint setPrintUnit start stop time insertTimerCode

Constructors

constructor

new TaskTimer($class?, code?, delay?, returnType?, timerName?, fullPath?): TaskTimer
Parameters
- $class: Class = ...
- code: string = "return null;"
- delay: number = 1
- returnType: string = "Object"
- timerName: string = "timedTask"
- fullPath: boolean = false
Returns TaskTimer
Overrides IntermediateTimer.constructor
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:167

Properties

$timerClass

$timerClass: Field

access

access: string

filename

filename: undefined | string

name

name: string

`Protected`print

print: boolean

`Protected`printUnit

printUnit: boolean

timeUnits

timeUnits: timeUnits

`Static` `Readonly`DEFAULT_CLASS_NAME

DEFAULT_CLASS_NAME = "kadabra.utils.Timers"

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

get

get(): string
Returns string
Overrides IntermediateTimer.get
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:200

getAfterJp

getAfterJp(): undefined | Joinpoint
Returns undefined | Joinpoint
The last join point that was inserted after the $end mark
Inherited from IntermediateTimer.getAfterJp
- Defined in lara-framework/Lara-JS/api/lara/code/TimerBase.d.ts:28

getAndStart

getAndStart(): string
Returns string
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:204

getUnit

getUnit(): timeUnits
Returns timeUnits
Inherited from IntermediateTimer.getUnit
- Defined in lara-framework/Lara-JS/api/lara/code/TimerBase.d.ts:24

measure

measure($target, message?, $end?): undefined | string
Parameters
- $target: Joinpoint
- Optionalmessage: string
- $end: Joinpoint = $target
Returns undefined | string
Inherited from IntermediateTimer.measure
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:39

measureCode

measureCode(action, $target?, when?): string
Parameters
- action: string
- Optional$target: Joinpoint
- Optionalwhen: insertOptions
Returns string
Inherited from IntermediateTimer.measureCode
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:56

ready

ready(): string
Returns string
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:196

setAfterJp

setAfterJp($afterJp): void
Sets the join point that should be returned by .getAfterJp().
Parameters
- $afterJp: undefined | Joinpoint
Returns void
Inherited from IntermediateTimer.setAfterJp
- Defined in lara-framework/Lara-JS/api/lara/code/TimerBase.d.ts:32

setPrint

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

setPrintUnit

setPrintUnit(printUnit): this
Parameters
- printUnit: boolean
Returns this
Inherited from IntermediateTimer.setPrintUnit
- Defined in lara-framework/Lara-JS/api/lara/code/TimerBase.d.ts:22

start

start(): string
Returns string
Overrides IntermediateTimer.start
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:188

stop

stop(): string
Returns string
Overrides IntermediateTimer.stop
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:192

time

time($start, prefix?, $end?): undefined | string
Times the code of a given section.
Parameters
- $start: Joinpoint
  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: Joinpoint
  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.
Inherited from IntermediateTimer.time
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:52

`Static`insertTimerCode

insertTimerCode(code, $target, when?): Joinpoint
Parameters
- code: string
- $target: Joinpoint
- when: insertOptions = "before"
Returns Joinpoint
Inherited from IntermediateTimer.insertTimerCode
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:65