Click or drag to resize

StructureCollection Methods

The StructureCollection type exposes the following members.

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 methodFinish
Finalize run
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInitialize
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)

Public methodInitializeCollection
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.

Public methodLoad(PFSSection, String)
Public methodLoad(IntPtr, String)
Public methodLoad(String, String)
Loads a collection of structures from a file or data base.
Public methodLoad(PFSSection, String, ControlData, IDiagnostics)
Public methodLoad(IntPtr, String, ControlData, IDiagnostics)
Public methodLoad(String, String, ControlData, IDiagnostics)
Load a structure collection
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodPrepare(HDParameterData, IDiagnostics)
Prepare all structures.
Public methodPrepare(DateTime, HDParameterData, IDiagnostics)
Prepare all structures.
Public methodReadState
Public methodResetControlledState
Reset the controlled state of all controllable structures in the collection
Public methodSetDelhsForAllStructures
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

Public methodSetMaximumIterationsForAllStructures
Minimum head loss across a structure. Default value = 0.01
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodValidate
Validates the data of all strucures in the collection. Diagnostics, Warning and Hints are collected in each of the published classes for the purpose.
Public methodWriteState
Top
Extension Methods
  NameDescription
Public Extension MethodRemovableStructure
Returns true if the structure at that location is removable
(Defined by StructureExtensions.)
Public Extension MethodSetBaseFilePath
Set base file path for all structures
(Defined by StructureExtensions.)
Top
See Also