Click or drag to resize

State Class

State in ControlStateMachine.

Use CreateState(IAction) to create a new state and add it to the state matchine instance.

Inheritance Hierarchy
SystemObject
  DHI.Mike1D.ControlModuleState

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 State

The State type exposes the following members.

Properties
  NameDescription
Public propertyAction
Action that state implements
Public propertyActivationTime
Activation time is the time when this action was activated. Reset when this action becomes active AFTER another action (ie not reset if this action is re-activated after BlockTime expires.
Public propertyBlockTime
If > 0, then this state is active for at least BlockTime.
Public propertyBlockTimeBegin
Public propertyStrategyId
Id of control strategy

This is handled to the controlled item when the state is active, and can be reported in result files

Public propertyTransitionTable
State transition table, list of state transitions defining any state change.

Use SetStateTransitionTable(State, StateTransitionTable) to update.

Public propertyUseBlockTimeStep
When true: After block-time has expired, if this state continues to be active, a new period of blocking is initiated, so this state will be active for yet another BlockTime period. State changes will only be evaluated every BlockTime period.

When false: After block time has expired, at any time can the state change.

Top
Methods
  NameDescription
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.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also