Click or drag to resize

ActionPID Properties

The ActionPID type exposes the following members.

Properties
  NameDescription
Public propertyActivationTime
Time when action was activated
(Inherited from Action.)
Public propertyControl
Function called when the action is implemented.
(Inherited from ActionSetBase.)
Public propertyControllableUpdate (Inherited from Action.)
Public propertyCurrentControlValueGetter
CurrentControlValueGetter 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.)
Public propertyDerivationPeriod
Derivation period. Default: 0.8 hour
Public propertyId
Id of action
(Inherited from Action.)
Public propertyIntegrationPeriod
Integration period. Default : 300 hours
Public propertyIsActive
Boolean indicating if action is active
(Inherited from Action.)
Public propertyProportionalityFactor
Factor of proportionality Type: Dimensionless factor Default: 1
Public propertyReferenceExpression
Reference expression, often called Set Point, is the value that we want the RegulatedExpression to be, and what the PID will try to obtain.
Public propertyRegulatedExpression
RegulatedExpression 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.
Public propertyUnit (Inherited from ActionSetBase.)
Public propertyWeightTimeStep1
Weighting factor for time step 1 Type: Dimensionless factor Default: 1
Public propertyWeightTimeStep2
Weighting factor for time step 2 Type: Dimensionless factor Default: 0.7
Public propertyWeightTimeStep3
Weighting factor for time step 3 Type: Dimensionless factor Default: 1
Top
See Also