Click or drag to resize

ActionPID Class

Action to set a value (via Action.ValueSetter) based on an input expression. Optinally, the value can be multiplied by the value of OutExpressionFactor, before the value is passed on to the value setter.
Inheritance Hierarchy

Namespace:  DHI.Mike1D.ControlModule
Assembly:  DHI.Mike1D.ControlModule (in DHI.Mike1D.ControlModule.dll) Version: 19.0.0.0 (11.1.1.1111)
Syntax
public class ActionPID : ActionSetBase

The ActionPID type exposes the following members.

Constructors
  NameDescription
Public methodActionPID
Create new action
Top
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
Methods
  NameDescription
Public methodActivate
Called when action is first activated. The state of the action should be initialized here.
(Overrides ActionActivate(DateTime, Int32).)
Protected methodConvert
Convert value from Unit to SI (engine) units
(Inherited from ActionSetBase.)
Public methodDeactivate
Called when this action is deactivated and another action is activated.
(Inherited from Action.)
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodImplement
Implement constant action.
(Overrides ActionImplement(DateTime, DateTime, Int32).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodReadState (Overrides ActionReadState(ModelStateReader).)
Public methodReset
Reset the internal state of the action
(Overrides ActionReset.)
Protected methodRevert
Convert value from SI (engine) units to Unit
(Inherited from ActionSetBase.)
Protected methodSetActive
Set this action as the active one
(Inherited from Action.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate (Overrides ActionValidate.)
Public methodWriteState (Overrides ActionWriteState(ModelStateWriter).)
Top
Fields
  NameDescription
Protected field_activationTime (Inherited from Action.)
Protected field_control (Inherited from ActionSetBase.)
Protected field_currentControlValueGetter (Inherited from ActionSetBase.)
Protected field_id (Inherited from Action.)
Protected field_isActive (Inherited from Action.)
Protected field_referenceExpression
Protected field_toSIFactor (Inherited from ActionSetBase.)
Protected field_toSIOffset (Inherited from ActionSetBase.)
Protected field_unit (Inherited from ActionSetBase.)
Top
See Also