ActionPID Properties

Properties

ActivationTime Time when action was activated
(Inherited from Action)
Control Function called when the action is implemented.
(Inherited from ActionSetBase)
ControllableUpdate
(Inherited from Action)
CurrentControlValueGetterCurrentControlValueGetter is a getter to access the current value of the controlled structure. For ActionPID and ActionChange, the new control value is calculated as a adjustment of the value of the controlled structure.
(Inherited from ActionSetBase)
DerivationPeriod Derivation period. Default: 0.8 hour
Id Id of action
(Inherited from Action)
IntegrationPeriod Integration period. Default : 300 hours
IsActive Boolean indicating if action is active
(Inherited from Action)
ProportionalityFactor Factor of proportionality Type: Dimensionless factor Default: 1
ReferenceExpression Reference expression, often called Set Point, is the value that we want the RegulatedExpression to be, and what the PID will try to obtain.
RegulatedExpressionRegulatedExpression is an expression for the measured control variable. This value is what the PID controller will try to get to match the setpoint expression value. The new control value is calculated so as to minimize the difference between RegulatedExpressionValue() and ReferenceExpressionValue(), where RegulatedExpressionValue() is the value that changes in response to the control.
Unit Unit of action. If defined, the value of the action is converted from this unit to the unit of the engine (EUM base unit) before being applied.
(Inherited from ActionSetBase)
WeightTimeStep1 Weighting factor for time step 1 Type: Dimensionless factor Default: 1
WeightTimeStep2 Weighting factor for time step 2 Type: Dimensionless factor Default: 0.7
WeightTimeStep3 Weighting factor for time step 3 Type: Dimensionless factor Default: 1

See Also