Package com.inductiveautomation.ignition.gateway.metrics

Class DescriptiveRatioGauge

java.lang.Object

com.inductiveautomation.ignition.gateway.metrics.DescriptiveRatioGauge

All Implemented Interfaces:

com.codahale.metrics.Gauge<Double>, com.codahale.metrics.Metric, DescriptiveMetric

Direct Known Subclasses:

DatasourceResourcesMetric, DefaultResourceEntityDelegate.ActiveResourcesMetric, DefaultResourceEntityDelegate.EnabledResourcesMetric, MetricBuilder.SupplierDrivenDescriptiveRatioGauge

public abstract class DescriptiveRatioGauge
extends Object
implements com.codahale.metrics.Gauge<Double>, DescriptiveMetric

This class is mostly a copy of the RatioGauge from the Metrics library. The difference is that the Ratio itself and its numerator and denominator are exposed so that the gauge can be rendered as a radio of X over Y rather than just as a number.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DescriptiveRatioGauge.Ratio	A ratio of one quantity to another.

Constructor Summary

Constructors

Constructor	Description
DescriptiveRatioGauge(Function<Locale,String> description, Function<Locale,String> units)

Method Summary

Modifier and Type	Method	Description
String	getDescription(Locale locale)	A short description of what this metric represents.
Double	getErrorValue()
abstract DescriptiveRatioGauge.Ratio	getRatio()
String	getUnits(Locale locale)	A short string representing the units of this metric.
Double	getValue()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.inductiveautomation.ignition.gateway.metrics.DescriptiveMetric

getDescription, getUnits

Constructor Details

DescriptiveRatioGauge

public DescriptiveRatioGauge(Function<Locale,String> description,
 Function<Locale,String> units)

Method Details

getDescription

public String getDescription(Locale locale)

Description copied from interface: DescriptiveMetric

A short description of what this metric represents. For example "JVM Heap Size" or "Thread Count" or "Subsystem X script executions"

Specified by:

getDescription in interface DescriptiveMetric

getUnits

public String getUnits(Locale locale)

Description copied from interface: DescriptiveMetric

A short string representing the units of this metric. For example "MB" or "threads" or "executions"

Specified by:

getUnits in interface DescriptiveMetric

getRatio

public abstract DescriptiveRatioGauge.Ratio getRatio()

Returns:

the Ratio which is the gauge's current value

getErrorValue

public Double getErrorValue()

Returns:

how much of the gauge's current value represents an errored state

getValue

public Double getValue()

Specified by:

getValue in interface com.codahale.metrics.Gauge<Double>