Package com.inductiveautomation.ignition.gateway.tags.actors.factories.scaling

Class ValueScaler

java.lang.Object

com.inductiveautomation.ignition.gateway.tags.actors.factories.scaling.ValueScaler

Direct Known Subclasses:

ValueScaler.AbstractDoubleScaler, ValueScaler.ArrayScalar, ValueScaler.BitInversionScalar, ValueScaler.EngLimitEnforcer, ValueScaler.NonScaler

public abstract class ValueScaler
extends java.lang.Object

Handles scaling of values for tags. Instantiated off of tag settings with the static configure function.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	ValueScaler.AbstractDoubleScaler
protected static class	ValueScaler.ArrayScalar
protected static class	ValueScaler.BitInversionScalar
protected static class	ValueScaler.EngLimitEnforcer
protected static class	ValueScaler.ExponentialFilterScaler
protected static class	ValueScaler.NonScaler
protected static class	ValueScaler.StandardScaler

Constructor Summary

Constructors

Constructor	Description
ValueScaler()

Method Summary

Modifier and Type	Method	Description
static ValueScaler	configure(PropertySet tagConfig)	Builds a value scaler for the given tag.
static ValueScaler	configure(ScaleMode mode, ClampMode clamp, java.lang.Double rawLow, java.lang.Double rawHigh, java.lang.Double scaledLow, java.lang.Double scaledHigh, java.lang.Double scaleFactor)
abstract QualifiedValue	deScale(QualifiedValue v)
boolean	isEnabled()	Returns whether the scaler actually does anything.
static ValueScaler	noScale()
abstract QualifiedValue	scale(QualifiedValue v)

Methods inherited from class java.lang.Object

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

Constructor Detail

ValueScaler

public ValueScaler()

Method Detail

noScale

public static ValueScaler noScale()

configure

public static ValueScaler configure(PropertySet tagConfig)

Builds a value scaler for the given tag. If tag is null, a scaler will be returned with mode of OFF.

configure

public static ValueScaler configure(ScaleMode mode,
                                    ClampMode clamp,
                                    java.lang.Double rawLow,
                                    java.lang.Double rawHigh,
                                    java.lang.Double scaledLow,
                                    java.lang.Double scaledHigh,
                                    java.lang.Double scaleFactor)

isEnabled

public boolean isEnabled()

Returns whether the scaler actually does anything.

scale

public abstract QualifiedValue scale(QualifiedValue v)

deScale

public abstract QualifiedValue deScale(QualifiedValue v)