public class ActionPID : ActionSetBase| ActionPID | Create new action |
| ActivationTime |
Time when action was activated
(Inherited from Action) |
| Control |
Function called when the action is implemented.
(Inherited from ActionSetBase) |
| ControllableUpdate | (Inherited from Action) |
| CurrentControlValueGetter | 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) |
| 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. |
| RegulatedExpression | 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. |
| 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 |
| Activate |
Called when action is first activated. The state of the action should be initialized here.
(Overrides ActionActivate(DateTime, Int32)) |
| Convert |
Convert value from Unit to SI (engine) units
(Inherited from ActionSetBase) |
| Deactivate |
Called when this action is deactivated and another action is activated.
(Inherited from Action) |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Implement |
Implement constant action.
(Overrides ActionImplement(DateTime, DateTime, Int32)) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ReadState |
Read state and apply to module.
Returns true if state was successfully read.
(Overrides ActionReadState(ModelStateReader)) |
| Reset |
Reset the internal state of the action
(Overrides ActionReset) |
| Revert |
Convert value from SI (engine) units to Unit (Inherited from ActionSetBase) |
| SetActive |
Set this action as the active one
(Inherited from Action) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Validate |
Validate
(Overrides ActionValidate) |
| WriteState |
Write current state of module
(Overrides ActionWriteState(ModelStateWriter)) |
| _activationTime | ActivationTime (Inherited from Action) |
| _control | (Inherited from ActionSetBase) |
| _currentControlValueGetter | (Inherited from ActionSetBase) |
| _id | Id of action (Inherited from Action) |
| _isActive | IsActive (Inherited from Action) |
| _toSIFactor | (Inherited from ActionSetBase) |
| _toSIOffset | (Inherited from ActionSetBase) |
| _unit | (Inherited from ActionSetBase) |