StructureCollection Methods

Methods

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)
Finish Finalize run
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Initialize Initialize structure collection. Use only when no boundary and cross section data is available, typically when the structure module is used independently (not part of network simulation)

Collects structures with identical location in composite structures.

This automatically calls Initialize(ICrossSection, ICrossSection, Boolean, IDiagnostics) on each structure in the collection, setting the IsLinkStructure to true (no cross sectino data available)

InitializeCollection Initialize structure collection

Collects structures with identical location in composite structures. Sets various properties on collection and individual structures

This does not call Initialize(ICrossSection, ICrossSection, Boolean, IDiagnostics). You need also to call initialize on each structure individually.

Load(IntPtr, String) 
Load(PFSSection, String) 
Load(String, String) Loads a collection of structures from a file or data base.
Load(IntPtr, String, ControlData, IDiagnostics) 
Load(PFSSection, String, ControlData, IDiagnostics) 
Load(String, String, ControlData, IDiagnostics) Load a structure collection
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare(HDParameterData, IDiagnostics) Prepare all structures.
Prepare(DateTime, HDParameterData, IDiagnostics) Prepare all structures.
ReadState Read state and apply to module. Returns true if state was successfully read.
ResetControlledState Reset the controlled state of all controllable structures in the collection
SetDelhsForAllStructures Forces a setting of Delhs for all structures in the collection that uses linear zero variation.

For water level differences less than Delhs a linear Q variation is used between h1-h2=delhs and h1-h2=0. This is to avoid stability problems for small water level differences where dQdh goes to infinity.

Note that structures subsequently added to the collection, do not automatically get the Delhs value.

Unit: [m]. Default: 0.01

SetMaximumIterationsForAllStructures Minimum head loss across a structure. Default value = 0.01
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Validates the data of all structures in the collection. Diagnostics, Warning and Hints are collected in each of the published classes for the purpose.
WriteState Write current state of module

Extension Methods

RemovableStructure Returns true if the structure at that location is removable
(Defined by StructureExtensions)
SetBaseFilePath Set base file path for all structures
(Defined by StructureExtensions)

See Also