Class energyMetric

constructor

• new energyMetric(prefix?): energyMetric

• Parameters

  • prefix: string = "energy:"

  Returns energyMetric

energy

getImport

• getImport(): string

• Returns string

  A string with the LARA import of this Metric.

getUnit

• getUnit(): string

• Returns string

  A string with the current unit of this metric.

instrument

• instrument($start, $end?): void

• Instruments code so that when executed, it produces information about the metric to measure.

  Parameters

  • $start: Joinpoint

    join point representing the start point of the instrumentation
  • $end: Joinpoint = $start

    join point representing the end point of the instrumentation

  Returns void

report

• report(processExecutor): metricResult

• Extract metric.

  Parameters

  • processExecutor: processExecutor

    Instance after program execution

  Returns metricResult

  Metric after program execution