Class Timer

Hierarchy

IntermediateTimer
- Timer

Index

Constructors

Properties

$timerClass access filename name print printUnit timeUnits DEFAULT_CLASS_NAME

Methods

_timeValidate get getAfterJp getAvg getCount getTime getUnit measure measureCode pause setAfterJp setPrint setPrintUnit start stop time insertTimerCode millisTimer nanoTimer

Constructors

constructor

new Timer(
    name: string,
    $timerClassInCode: Field,
    unit: TimerUnit,
    fullPath: boolean,
): Timer
Parameters
- name: string
- $timerClassInCode: Field
- unit: TimerUnit
- fullPath: boolean
Returns Timer
Inherited from IntermediateTimer.constructor
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:16

Properties

$timerClass

$timerClass: Field

access

access: string

filename

filename: string | undefined

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: 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
- $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(
    $target?: Joinpoint,
    when?: insertOptions,
    message?: string,
): string | undefined
Parameters
- Optional$target: Joinpoint
- when: insertOptions = "before"
- message: string = ""
Returns string | undefined
Overrides IntermediateTimer.get
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:148

getAfterJp

getAfterJp(): Joinpoint | undefined
Returns Joinpoint | undefined
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

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

measureCode

measureCode(action: string, $target?: Joinpoint, when?: insertOptions): 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

pause

pause($target?: Joinpoint, when?: insertOptions): string
Parameters
- Optional$target: Joinpoint
- Optionalwhen: insertOptions
Returns string
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:132

setAfterJp

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

setPrint

setPrint(print: boolean): 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: boolean): 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($target?: Joinpoint, when?: insertOptions): string
Parameters
- Optional$target: Joinpoint
- Optionalwhen: insertOptions
Returns string
Overrides IntermediateTimer.start
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:124

stop

stop($target?: Joinpoint, when?: insertOptions): string
Parameters
- Optional$target: Joinpoint
- Optionalwhen: insertOptions
Returns string
Overrides IntermediateTimer.stop
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:128

time

time($start: Joinpoint, prefix?: string, $end?: Joinpoint): string | undefined
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 string | undefined
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: string,
    $target: Joinpoint,
    when?: insertOptions,
): 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

`Static`millisTimer

millisTimer($targetClass?: Class, timerName?: string, fullPath?: boolean): Timer
Parameters
- Optional$targetClass: Class
- timerName: string = "timer"
- fullPath: boolean = true
Returns Timer
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:98

`Static`nanoTimer

nanoTimer($targetClass?: Class, timerName?: string, fullPath?: boolean): Timer
Parameters
- Optional$targetClass: Class
- timerName: string = "timer"
- fullPath: boolean = true
Returns Timer
- Defined in kadabra/Kadabra-JS/src-api/kadabra/monitor/Timer.ts:111

Class Timer

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Timer

Properties

$timerClass

access

filename

name

Protectedprint

ProtectedprintUnit

timeUnits

Static ReadonlyDEFAULT_CLASS_NAME

Methods

Protected_timeValidate

Parameters

Returns boolean

get

Parameters

Returns string | undefined

getAfterJp

Returns Joinpoint | undefined

getAvg

Returns string

getCount

Returns string

getTime

Returns string

getUnit

Returns TimeUnits

measure

Parameters

Returns string | undefined

measureCode

Parameters

Returns string

pause

Parameters

Returns string

setAfterJp

Parameters

Returns void

setPrint

Parameters

Returns this

setPrintUnit

Parameters

Returns this

start

Parameters

Returns string

stop

Parameters

Returns string

time

Parameters

Returns string | undefined

StaticinsertTimerCode

Parameters

Returns Joinpoint

StaticmillisTimer

Parameters

Returns Timer

StaticnanoTimer

Parameters

Returns Timer

Settings

On This Page

`Protected`print

`Protected`printUnit

`Static` `Readonly`DEFAULT_CLASS_NAME

`Protected`_timeValidate

`Static`insertTimerCode

`Static`millisTimer

`Static`nanoTimer