com.inductiveautomation.ignition.gateway.sqltags.execution

Class Deadband

java.lang.Object

com.inductiveautomation.ignition.gateway.sqltags.execution.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 and 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 and Description
protected double	limit
static Deadband	NO_DEADBAND
static Deadband.DeadbandResult	SCALAR_NO
static Deadband.DeadbandResult	SCALAR_YES

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Deadband(java.lang.Double limit)

Method Summary

Modifier and Type	Method and 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(java.lang.Number previous, java.lang.Number current)
Deadband.DeadbandResult	hasChanged(QualifiedValue previous, QualifiedValue 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)

Methods inherited from class java.lang.Object

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

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

Constructor Detail

Deadband

protected Deadband(java.lang.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(java.lang.Double rangeLow,
                                     java.lang.Double rangeHigh,
                                     double limit)