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.

Definition

Namespace: DHI.Mike1D.ControlModule
Assembly: DHI.Mike1D.ControlModule (in DHI.Mike1D.ControlModule.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class ActionUnchanged : ActionSetBase
Inheritance
Object    Action    ActionSetBase    ActionUnchanged

Constructors

ActionUnchanged Create new action

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)
Id Id of action
(Inherited from Action)
IsActive Boolean indicating if action is active
(Inherited from Action)
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)

Methods

Activate
(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)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Implement Implement action, update value of controlled item.
(Overrides ActionImplement(DateTime, DateTime, Int32))
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
ReadState Read state and apply to module. Returns true if state was successfully read.
(Inherited from Action)
Reset Reset the internal state of the action.
(Inherited from Action)
Revert Convert value from SI (engine) units to Unit
(Inherited from ActionSetBase)
SetActive Set this action as the active one
(Inherited from Action)
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Validate
(Overrides ActionValidate)
WriteState Write current state of module
(Inherited from Action)

Fields

_activationTimeActivationTime
(Inherited from Action)
_control
(Inherited from ActionSetBase)
_currentControlValueGetter
(Inherited from ActionSetBase)
_id Id of action
(Inherited from Action)
_isActiveIsActive
(Inherited from Action)
_toSIFactor
(Inherited from ActionSetBase)
_toSIOffset
(Inherited from ActionSetBase)
_unit
(Inherited from ActionSetBase)

See Also