ActionSetBase Class |
Base class for actions using the ActionControl
method for implementing an action.
It contains methods for getting values of the controlled item and updating the controlled item.
Inheritance HierarchySystemObject
DHI.Mike1D.ControlModuleAction
DHI.Mike1D.ControlModuleActionSetBase
DHI.Mike1D.ControlModuleActionPID
DHI.Mike1D.ControlModuleActionSet
DHI.Mike1D.ControlModuleActionUnchanged
DHI.Mike1D.ControlModuleAction
DHI.Mike1D.ControlModuleActionSetBase
DHI.Mike1D.ControlModuleActionPID
DHI.Mike1D.ControlModuleActionSet
DHI.Mike1D.ControlModuleActionUnchanged
Namespace: DHI.Mike1D.ControlModule
Assembly: DHI.Mike1D.ControlModule (in DHI.Mike1D.ControlModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe ActionSetBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | ActionSetBase | Initializes a new instance of the ActionSetBase class |
Properties| Name | Description | |
|---|---|---|
 | ActivationTime |
Time when action was activated
(Inherited from Action.) |
| Control |
Function called when the action is implemented.
|
| 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.
|
| Id |
Id of action
(Inherited from Action.) |
| IsActive |
Boolean indicating if action is active
(Inherited from Action.) |
| Unit |
Methods| Name | Description | |
|---|---|---|
 | 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
|
| 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 action, update value of controlled item.
(Inherited from Action.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ReadState | (Inherited from Action.) |
| Reset |
Reset the internal state of the action.
(Inherited from Action.) |
| Revert |
Convert value from SI (engine) units to Unit |
| 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
(Inherited from Action.) |
| WriteState | (Inherited from Action.) |
Fields| Name | Description | |
|---|---|---|
 | _activationTime | (Inherited from Action.) |
| _control | |
| _currentControlValueGetter | |
| _id | (Inherited from Action.) |
| _isActive | (Inherited from Action.) |
| _toSIFactor | |
| _toSIOffset | |
| _unit |
See Also