Package com.inductiveautomation.ignition.gateway.metrics

Class MetricBuilder.SupplierDrivenDescriptiveRatioGauge

java.lang.Object

com.inductiveautomation.ignition.gateway.metrics.DescriptiveRatioGauge

com.inductiveautomation.ignition.gateway.metrics.MetricBuilder.SupplierDrivenDescriptiveRatioGauge

All Implemented Interfaces:

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

Enclosing class:

MetricBuilder

public static class MetricBuilder.SupplierDrivenDescriptiveRatioGauge
extends DescriptiveRatioGauge

Nested Class Summary

Nested classes/interfaces inherited from class com.inductiveautomation.ignition.gateway.metrics.DescriptiveRatioGauge

DescriptiveRatioGauge.Ratio

Constructor Summary

Constructors

Constructor	Description
SupplierDrivenDescriptiveRatioGauge(Function<Locale,String> description, Function<Locale,String> units, Supplier<Double> numerator, Supplier<Double> denominator)

Method Summary

Modifier and Type	Method	Description
DescriptiveRatioGauge.Ratio	getRatio()

Methods inherited from class com.inductiveautomation.ignition.gateway.metrics.DescriptiveRatioGauge

getDescription, getUnits, 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

SupplierDrivenDescriptiveRatioGauge

public SupplierDrivenDescriptiveRatioGauge(Function<Locale,String> description,
 Function<Locale,String> units,
 Supplier<Double> numerator,
 Supplier<Double> denominator)

Method Details

getRatio

public DescriptiveRatioGauge.Ratio getRatio()

Specified by:

getRatio in class DescriptiveRatioGauge

Returns:

the Ratio which is the gauge's current value