LinkRegulationStructure Methods

Methods

Accepts List of data types that is accepted, i.e., that you can get a ValueSetter for.
(Inherited from Structure)
AddToOffers Add additional offers to structure
(Inherited from Structure)
ApplyFlowFactor Applies flow factor to discharge and it's derivatives
(Inherited from Structure)
ControlClose Close gate, set the discharge to zero
ControlSetDischarge Set the discharge to use
ControlSetFlowFactor Set flow factor to specified value
(Inherited from Structure)
Description Return a string that describes this structure. Includes structure type and ID
(Inherited from Structure)
Dispose Frees the licenses held.
(Inherited from Structure)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
ExplicitStructureSupport DEBUG: This method is called from Validate() if _implitcit == false to check if the structure supports being Explicit. Once all structures support explicit operation this method can be deleted.
(Inherited from Structure)
FinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object)
GetActionInfos List of control action infos
(Overrides StructureGetActionInfos)
GetControlAction Get control action for the specified id. It always returns one of the ActionControl delegates. It will return null if controlActionId is not valid.

Base implementation for IControllable


(Overrides StructureGetControlAction(String))
GetCurrentValue Get the current value of the control for the specified id.

Base implementation for IControllable


(Overrides StructureGetCurrentValue(String))
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Initialize(IDiagnostics) Set up structure and set runtime diagnostics object
(Inherited from Structure)
Initialize(ICrossSection, ICrossSection, Boolean, IDiagnostics) Set up structure and set runtime diagnostics object
(Overrides StructureInitialize(ICrossSection, ICrossSection, Boolean, IDiagnostics))
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Offers A list of quantities available from this structure
(Inherited from Structure)
Prepare(HDParameterData, IDiagnostics) Set up structure and set runtime diagnostics object
(Overrides StructurePrepare(HDParameterData, IDiagnostics))
Prepare(DateTime, HDParameterData, IDiagnostics) Set up structure and set runtime diagnostics object
(Inherited from Structure)
ResetControlledState Reset internal state (if any) used by controlling class. Called after a controlling class has performed a control sequence, and simulation is restarted.

Base implementation for IControllable


(Overrides StructureResetControlledState)
SetControlStrategyId Set control strategy ID manually.

Base implementation for IControllable


(Inherited from Structure)
SetInputWaterLevels Set the _upstreamWaterLevel, _downstreamWaterLevel and _flowDir
(Inherited from Structure)
SetWaterLevels Sets up- and down- stream water level. For DischargeGate, SetWaterLevels() does nothing else than implements limits on discharge if _upstreamWaterLevelMinMaxTable != null.
(Overrides StructureSetWaterLevels(Double, Double))
SetZeroFlow Sets the conditions for zero flow
(Inherited from Structure)
ToStringReturns a string that represents the current object.
(Overrides ObjectToString)
UpdatedWaterLevels After a time step (or iteration) has finished, update the discharge to the actual value, based on the final water levels and the discharge derivatives.
(Inherited from Structure)
Validate Writes errors, warnings and hints into their respective member classes. The member objects are initially cleared.
(Overrides StructureValidate)
ValueGetter Get value setter for the specified data quantity
(Overrides StructureValueGetter(Int32))
ValueSetter Get value setter for the specified data type
(Inherited from Structure)

Extension Methods

GetControlActionInfo Get control action info for the specified id. It will return null if controlActionId is not valid.
(Defined by StructureExtensions)

See Also