ActionSet Class

Action that will set the value of the ValueExpression to the controlled item.

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 ActionSet : ActionSetBase
Inheritance
Object    Action    ActionSetBase    ActionSet
Derived

Constructors

ActionSet 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)
ValueExpression Expression value used when action is implemented

Methods

Activate Called when action is first activated. The state of the action should be initialized here.
(Inherited from Action)
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)
_valueExpression 

See Also