Package com.inductiveautomation.ignition.gateway.metrics

Class DescriptiveRatioGauge.Ratio

java.lang.Object

com.inductiveautomation.ignition.gateway.metrics.DescriptiveRatioGauge.Ratio

Enclosing class:

DescriptiveRatioGauge

public static class DescriptiveRatioGauge.Ratio
extends Object

A ratio of one quantity to another.

Field Summary

Fields

Modifier and Type	Field	Description
final double	denominator
final double	numerator

Method Summary

Modifier and Type	Method	Description
double	getValue()	Returns the ratio, which is either a double between 0 and 1 (inclusive) or NaN.
static DescriptiveRatioGauge.Ratio	of(double numerator, double denominator)	Creates a new ratio with the given numerator and denominator.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

numerator

public final double numerator

denominator

public final double denominator

Method Details

of

public static DescriptiveRatioGauge.Ratio of(double numerator,
 double denominator)

Creates a new ratio with the given numerator and denominator.

Parameters:

numerator - the numerator of the ratio

denominator - the denominator of the ratio

Returns:

numerator:denominator

getValue

public double getValue()

Returns the ratio, which is either a double between 0 and 1 (inclusive) or NaN.

Returns:

the ratio

toString

public String toString()

Overrides:

toString in class Object