Reset¶
Doc Home > API Index > control > Reset
Inheritance¶
sys::Obj sys::Virtual sys::Component control::Reset
public class Reset
[niagaraIcon="module://icons/x16/control/math/reset.png"]
Reset re-scales in value to out value object
This function performs a "reset" on the input value.
"Reset" is a HVAC term for scaling a number between two limits.
When inMin < inA < inMax, the output value scales linearly between outMin and outMax.
If inA < inMin, the value is capped at outMin.
If inA > inMax, the value is capped at outMax.
To calculate out, the following equation is used:
(outMax-outMin) out = --------------- * (in - inMin) + outMin (inMax-inMin)
Fields¶
in¶
public property float in
input
inMax¶
public property float inMax [config]
scaling constant inMax
inMin¶
public property float inMin [config]
scaling constant inMin
out¶
public property float out [readonly]
re-scaled output
outMax¶
public property float outMax [config]
scaling constant outMax
outMin¶
public property float outMin [config]
scaling constant outMin
Methods¶
changed¶
public override void changed(Slot slot)
Behavior to execute when a property is changed externally
execute¶
public virtual override void execute()
Execute is called once every scan.
start¶
public virtual override void start()
Callback when component is first started in an app.
Doc Home > API Index > control > Reset