Class Deadband
- java.lang.Object
-
- com.inductiveautomation.ignition.gateway.tags.evaluation.util.Deadband
-
- Direct Known Subclasses:
Deadband.AbsoluteDeadbandDouble
,Deadband.AbsoluteDeadbandInt
,Deadband.NoDeadband
,Deadband.PercentDeadband
public abstract class Deadband extends java.lang.Object
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Deadband.AbsoluteDeadbandDouble
static class
Deadband.AbsoluteDeadbandInt
static class
Deadband.DeadbandResult
Provides the state of the deadband, whether or not the value has changed.protected static class
Deadband.NoDeadband
static class
Deadband.PercentDeadband
-
Field Summary
Fields Modifier and Type Field Description protected double
limit
static Deadband
NO_DEADBAND
static Deadband.DeadbandResult
SCALAR_NO
static Deadband.DeadbandResult
SCALAR_YES
-
Constructor Summary
Constructors Modifier Constructor Description protected
Deadband(java.lang.Double limit)
-
Method Summary
All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected Deadband.DeadbandResult
arrayPassesDeadband(java.lang.Object previous, java.lang.Object current)
static Deadband
createAbsolute(double limit, boolean isInteger)
static Deadband
createPercent(java.lang.Double rangeLow, java.lang.Double rangeHigh, double limit)
double
getLimit()
Deadband.DeadbandResult
hasChanged(QualifiedValue previous, QualifiedValue current)
Deadband.DeadbandResult
hasChanged(java.lang.Number previous, java.lang.Number current)
protected abstract boolean
scalarPassesDeadband(java.lang.Object previous, java.lang.Object current)
Evaluates whether the deadband has been exceeded.void
setLimit(java.lang.Double limit)
java.lang.String
toString()
-
-
-
Field Detail
-
NO_DEADBAND
public static Deadband NO_DEADBAND
-
SCALAR_YES
public static final Deadband.DeadbandResult SCALAR_YES
-
SCALAR_NO
public static final Deadband.DeadbandResult SCALAR_NO
-
limit
protected double limit
-
-
Method Detail
-
getLimit
public double getLimit()
-
setLimit
public void setLimit(java.lang.Double limit)
-
hasChanged
public Deadband.DeadbandResult hasChanged(QualifiedValue previous, QualifiedValue current)
-
hasChanged
public Deadband.DeadbandResult hasChanged(java.lang.Number previous, java.lang.Number current)
-
arrayPassesDeadband
protected Deadband.DeadbandResult arrayPassesDeadband(java.lang.Object previous, java.lang.Object current)
-
scalarPassesDeadband
protected abstract boolean scalarPassesDeadband(java.lang.Object previous, java.lang.Object current)
Evaluates whether the deadband has been exceeded. Called after null and quality have been checked, passed the internal values of the qualified values.
-
createAbsolute
public static Deadband createAbsolute(double limit, boolean isInteger)
-
createPercent
public static Deadband createPercent(@Nullable java.lang.Double rangeLow, @Nullable java.lang.Double rangeHigh, double limit)
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
-