Click or drag to resize

ActionUnchanged Class

Action that, when activated, will read the current control value (CurrentControlValueGetter) and set that to the controlled item as the new target value.

In case the control has another target value and is has not yet reached the target (because of a velocity limitation or similar) but is moving towards that target, this action will stop that process, by resetting the target value to the current value.

Compared to the ActionNoOperation, the ActionNoOperation will not do anything, hence if the control is approaching a target value, it will continue do so. If the control is not in the move, there will be no difference between ActionNoOperation and this ActionUnchanged.

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 ActionUnchanged : ActionSetBase

The ActionUnchanged type exposes the following members.

Constructors
  NameDescription
Public methodActionUnchanged
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 propertyId
Id of action
(Inherited from Action.)
Public propertyIsActive
Boolean indicating if action is active
(Inherited from Action.)
Public propertyUnit (Inherited from ActionSetBase.)
Top
Methods
  NameDescription
Public methodActivate (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 action, update value of controlled item.
(Overrides ActionImplement(DateTime, DateTime, Int32).)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodReadState (Inherited from Action.)
Public methodReset
Reset the internal state of the action.
(Inherited from Action.)
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
Validate
(Overrides ActionValidate.)
Public methodWriteState (Inherited from Action.)
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_toSIFactor (Inherited from ActionSetBase.)
Protected field_toSIOffset (Inherited from ActionSetBase.)
Protected field_unit (Inherited from ActionSetBase.)
Top
See Also