ANTAREX API

Clava API

(.js)
laraImport("antarex.margot.dse.metric.MargotMetric");

(.lara)
import antarex.margot.dse.metric.MargotMetric;

Classes:

Constructor

Instance Members

new MargotMetric(name, unit)

Class that represents a metric used by mARGOt. It has a name and a unit.

For instance, it can represent time in us.

name: MargotMetricName - the name of the metric
unit: Unit - the unit this metric is measured in

addInfo(key, value)

Adds arbitrary information to this metric using a <key, value> pair.

key: any
value: any

convertUnit(value, unit, unitHasBaseName)

Converts a value in a provided unit to the unit of this metric.

value: Number - the value to convert
unit: string - the unit in which the value is represented
unitHasBaseName: any

getName()

Returns the name of this metric.

getUnit()

Returns the unit of this metric.

getUnitName()

Returns the name of the unit of this metric.

setUnit(unit)

Sets the unit of this metric.

unit: Unit - the new unit