AveragedMetric (HPCC Systems Commons Project 8.6.4-1 API)

java.lang.Object
- org.hpccsystems.commons.benchmarking.AveragedMetric

All Implemented Interfaces:

IMetric
```
public class AveragedMetric
extends Object
implements IMetric
```
A helper class that collects data points for a given metric and provides basic statistical functions.

Constructor Summary

Constructors
Constructor	Description
`AveragedMetric(String name)`
`AveragedMetric(String name, Units units)`
`AveragedMetric(String name, Units units, String desc)`
`AveragedMetric(IMetric metric)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`addDataPoint(double dataPoint)`
`void`	`discardOutliers()`
`double`	`getAvg()`
`String`	`getDescription()`
`double`	`getMax()`
`double`	`getMin()`
`String`	`getName()`
`double`	`getStdDev()`
`Units`	`getUnits()`
`double`	`getValue()`
`void`	`toJson(org.json.JSONArray metricArray)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AveragedMetric
```
public AveragedMetric(String name)
```

AveragedMetric

public AveragedMetric(String name,
                      Units units)

AveragedMetric

public AveragedMetric(String name,
                      Units units,
                      String desc)

AveragedMetric

public AveragedMetric(IMetric metric)

Method Detail

addDataPoint

public void addDataPoint(double dataPoint)

discardOutliers
```
public void discardOutliers()
```

getMin
```
public double getMin()
```

getMax
```
public double getMax()
```

getAvg
```
public double getAvg()
```

getStdDev
```
public double getStdDev()
```

toJson

public void toJson(org.json.JSONArray metricArray)

getValue
```
public double getValue()
```
Specified by:

getValue in interface IMetric

getName
```
public String getName()
```
Specified by:

getName in interface IMetric

getDescription
```
public String getDescription()
```
Specified by:

getDescription in interface IMetric

getUnits
```
public Units getUnits()
```
Specified by:

getUnits in interface IMetric