HDPipeDesignData Class

Initializes a new instance of the HDPipeDesignData class

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.

Holder of read/write information

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.

A list of items in the Pipe Design simulation. Each item contains a list of reaches that will be modified.

Holds data from an extended DataContract

Unit of input and output files

Name and path of mex file

PID derivation period in seconds. Default value 0.8 seconds.

PID integration period in seconds. Default value 300 seconds.

PID proportionality factors. Default value -1

PID weight of time step n to use when modifying the Manning number of reaches. Default value 1.

PID weight of time step n-1 to use when modifying the Manning number of reaches. Default value 1.

PID weight of time step n-2 to use when modifying the Manning number of reaches. Default value 1.

File path of the Pipe Design result file

Return a list of active HDPipeDesignOptimizationReach'es.

Convert length to SI units if necessary

Conversion from meters to feet, if InputOutputUnits is US

Delete result file (if possible) and delete all previously calculated diameters.

Determines whether the specified object is equal to the current object.

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.

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

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)

Loop through all reaches that are part of Pipe Design and return the one with the specified id.

Serves as the default hash function.

Gets the Type of the current instance.

Initialize

Creates a shallow copy of the current Object.

Create controls necessary to modify pipe Manning numbers and set pipe diameters from pipe design restul file

Read result file into active flag, init factor and previous results for each reach

Returns a string that represents the current object.

Check PipeDesignData for errors and inconsistencies

Write mex file, matching that of MOUSE

Write a Pipe Design result file. The result file is a PFS file that contains the pipe diameters from a Pipe Design simulation.

Protected holder of read/write info