Class EnergyMetric

constructor

• new EnergyMetric(prefix?: string): 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: Joinpoint, $end?: Joinpoint): 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: ProcessExecutor): MetricResult

  Extract metric.

  Parameters

  • processExecutor: ProcessExecutor

    Instance after program execution

  Returns MetricResult

  Metric after program execution