Class EnergyMetric

Measures energy consumed during an application.

Hierarchy (View Summary)

Metric<Joinpoint>
- EnergyMetric

Index

Constructors

Properties

Methods

getImport getName getUnit instrument report

Constructors

constructor

new EnergyMetric(prefix?: string): EnergyMetric
Parameters
- prefix: string = "energy:"
Returns EnergyMetric
Overrides Metric.constructor
- Defined in clava/Clava-JS/src-api/lara/metrics/EnergyMetric.ts:15

Properties

energy

energy: Energy

name

name: string

Methods

getImport

getImport(): string
Returns string
A string with the LARA import of this Metric.
Overrides Metric.getImport
- Defined in clava/Clava-JS/src-api/lara/metrics/EnergyMetric.ts:42

getName

getName(): string
Returns string
Inherited from Metric.getName
- Defined in lara-framework/Lara-JS/api/lara/metrics/Metric.d.ts:11

getUnit

getUnit(): string
Returns string
A string with the current unit of this metric.
Overrides Metric.getUnit
- Defined in clava/Clava-JS/src-api/lara/metrics/EnergyMetric.ts:46

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
Overrides Metric.instrument
- Defined in clava/Clava-JS/src-api/lara/metrics/EnergyMetric.ts:22

report

report(processExecutor: ProcessExecutor): MetricResult
Extract metric.
Parameters
- processExecutor: ProcessExecutor
  Instance after program execution
Returns MetricResult
Metric after program execution
Overrides Metric.report
- Defined in clava/Clava-JS/src-api/lara/metrics/EnergyMetric.ts:27