Package com.inductiveautomation.ignition.gateway.tags.evaluation.util

Class Deadband

java.lang.Object

com.inductiveautomation.ignition.gateway.tags.evaluation.util.Deadband

All Implemented Interfaces:

Diagnosable

Direct Known Subclasses:

Deadband.AbsoluteDeadbandDouble, Deadband.AbsoluteDeadbandInt, Deadband.NoDeadband, Deadband.PercentDeadband

public abstract class Deadband
extends Object
implements Diagnosable

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 final Deadband.DeadbandResult	SCALAR_NO
static final Deadband.DeadbandResult	SCALAR_YES

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Deadband(Double limit)

Method Summary

Modifier and Type	Method	Description
protected Deadband.DeadbandResult	arrayPassesDeadband(Object previous, Object current)
static Deadband	createAbsolute(double limit, boolean isInteger)
static Deadband	createPercent(Double rangeLow, Double rangeHigh, double limit)
double	getLimit()
Deadband.DeadbandResult	hasChanged(QualifiedValue previous, QualifiedValue current)
Deadband.DeadbandResult	hasChanged(Number previous, Number current)
void	sampleDiagnostics(DiagnosticsSample sample)	Provides the sample upon which the object can set diagnostics information.
protected abstract boolean	scalarPassesDeadband(Object previous, Object current)	Evaluates whether the deadband has been exceeded.
void	setLimit(Double limit)
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

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 Details

Deadband

protected Deadband(Double limit)

Method Details

getLimit

public double getLimit()

setLimit

public void setLimit(Double limit)

sampleDiagnostics

public void sampleDiagnostics(DiagnosticsSample sample)

Description copied from interface: Diagnosable

Provides the sample upon which the object can set diagnostics information. It is expected that the calling object will first call getSubSample() in order to specify a useful identifier for this object's data.

Specified by:

sampleDiagnostics in interface Diagnosable

hasChanged

public Deadband.DeadbandResult hasChanged(QualifiedValue previous,
 QualifiedValue current)

hasChanged

public Deadband.DeadbandResult hasChanged(Number previous,
 Number current)

arrayPassesDeadband

protected Deadband.DeadbandResult arrayPassesDeadband(Object previous,
 Object current)

scalarPassesDeadband

protected abstract boolean scalarPassesDeadband(Object previous,
 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
 Double rangeLow,
 @Nullable
 Double rangeHigh,
 double limit)

toString

public String toString()

Overrides:

toString in class Object