IStructureCollection Interface |
Data access model for the structure module.
Namespace: DHI.Mike1D.StructureModule
Assembly: DHI.Mike1D.StructureModule (in DHI.Mike1D.StructureModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe IStructureCollection type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | CompositStructures |
The Composite structures is a list of all unique positions in the network
with a structure. Each composite structure can contain more than one structure,
also called parallel structures. This list of composit structures is a computational
list, created during Initialize().
|
| Parameters |
Parameters used during initialization
|
| RemovableStructureLocations |
List of locations of structures that can be removed, and replaced
by an ordinary HD calculation, as if there where not structure there
originally.
|
| Structures |
The list of all structures defined.
|
Methods| Name | Description | |
|---|---|---|
 | Finish |
Finalize run
|
| 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 section 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(PFSSection, String) |
Loads a collection of structures from a file or data base.
|
| Load(IntPtr, String) |
Loads a collection of structures from a file or data base.
|
| Load(String, String) |
Loads a collection of structures from a file or data base.
|
| Load(PFSSection, String, ControlData, IDiagnostics) |
Loads a collection of structures from a file or data base.
|
| Load(IntPtr, String, ControlData, IDiagnostics) |
Loads a collection of structures from a file or data base.
|
| 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.
(Inherited from IModelStateReadWrite.) |
| ResetControlledState |
Reset the controlled state of all controllable structures in the collection
|
| Validate |
Validates the data of all strucures in the collection. Diagnostics, Warning and Hints are collected in each of
the published classes for the purpose.
|
| WriteState |
Write current state of module
(Inherited from IModelStateReadWrite.) |
Extension Methods| Name | Description | |
|---|---|---|
 | 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