HDPipeDesignData Class

Data class for pipe design data

Definition

Namespace: DHI.Mike1D.Mike1DDataAccess
Assembly: DHI.Mike1D.Mike1DDataAccess (in DHI.Mike1D.Mike1DDataAccess.dll) Version: 24.0.0.0 (11.1.1.1111)
C#
public class HDPipeDesignData : AbstractDataAccess
Inheritance
Object    AbstractDataAccess    HDPipeDesignData

Constructors

HDPipeDesignDataInitializes a new instance of the HDPipeDesignData class

Properties

CommercialPipeDiameters List of commercial pipe diameters. These are used for suggesting new pipe diameters after a simulation done. The smallest diameter larger than the computed diameter is used as suggestion.
Connection Holder of read/write information
(Inherited from AbstractDataAccess)
CustomTypes List of custom types stored in the data object and that must be serialized.

A custom type is e.g. a user implemented structure or catchment model. In order to store information on the custom type in the .m1dx file, the system needs to know which custom types are being used, and they must be added to this list.


(Inherited from AbstractDataAccess)
DesignOptimizationItems A list of items in the Pipe Design simulation. Each item contains a list of reaches that will be modified.
ExtensionData Holds data from an extended DataContract
(Inherited from AbstractDataAccess)
InputOutputUnits Unit of input and output files
MEXFile Name and path of mex file
PIDDerivationPeriod PID derivation period in seconds. Default value 0.8 seconds.
PIDIntegrationPeriod PID integration period in seconds. Default value 300 seconds.
PIDProportionalityFactor PID proportionality factors. Default value -1
PIDWeightTimeStep1 PID weight of time step n to use when modifying the Manning number of reaches. Default value 1.
PIDWeightTimeStep2 PID weight of time step n-1 to use when modifying the Manning number of reaches. Default value 1.
PIDWeightTimeStep3 PID weight of time step n-2 to use when modifying the Manning number of reaches. Default value 1.
ResultFile File path of the Pipe Design result file

Methods

ActiveReaches Return a list of active HDPipeDesignOptimizationReach'es.
ConvertFeetToMeterConditionally Convert length to SI units if necessary
ConvertMeterToFeetConditionally Conversion from meters to feet, if InputOutputUnits is US
DeletePreviousResults Delete result file (if possible) and delete all previously calculated diameters.
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)
FindEngineReachFromId Find the EngineReach that has reachId == EngineReach.LocationSpan.ID. If multiple reaches exist that have the same ID in locations, then an exception is generated. Use this function from Prepare if the
FindPipeDesignItemFromId Find a Pipe Design item from an id. This is used from the control module when all the reaches in an item are controlled as a group (then the control module operates on the item instead of on the individual reaches)
FindPipeDesignReachFromId Loop through all reaches that are part of Pipe Design and return the one with the specified id.
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Initialize Initialize
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
Prepare Create controls necessary to modify pipe Manning numbers and set pipe diameters from pipe design restul file
ReadResultFile Read result file into active flag, init factor and previous results for each reach
ToStringReturns a string that represents the current object.
(Inherited from Object)
Validate Check PipeDesignData for errors and inconsistencies
WriteMEXFile Write mex file, matching that of MOUSE
WriteResultFile Write a Pipe Design result file. The result file is a PFS file that contains the pipe diameters from a Pipe Design simulation.

Fields

_connection Protected holder of read/write info
(Inherited from AbstractDataAccess)

See Also