CrossSectionFactory Class |
A factory builder for creating cross sections.
To create a new cross section, first create a CrossSectionFactory. Then build the base of the cross section by calling one of the BuildXXX functions. Use the SetXXX functions to customize the cross section. Get the finished cross section from GetCrossSection
Inheritance HierarchyNamespace: DHI.Mike1D.CrossSectionModule
Assembly: DHI.Mike1D.CrossSectionModule (in DHI.Mike1D.CrossSectionModule.dll) Version: 19.0.0.0 (11.1.1.1111)
SyntaxThe CrossSectionFactory type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | CrossSectionFactory | Initializes a new instance of the CrossSectionFactory class |
Methods| Name | Description | |
|---|---|---|
| BuildCircular |
Class to build a cross section.
|
| BuildCircularPreprocessed |
Class to build a cross section.
|
| BuildOpen |
Build a CrossSectionLocated with an XSOpen as base cross section
|
| BuildPolygon |
Build a CrossSectionLocated with an XSPolygon as base cross section
|
| BuildRectangular |
Build rectangular XS
|
| BuildRectangularPolygon |
Create a Polygon cross section representing a rectangle, with the given number
of equidistant processed levels.
Processed data has not yet been calculated, you should call Prepare(HDParameterData, IDiagnostics) before using it. |
| BuildRectangularPreprocessed |
Class to build a cross section.
Uses the Build Pattern.
|
| CrossSectionIsSymmetric |
Set XSBaseRaw base cross section to symmetric
|
| CrossSectionNeedsLocation |
Set if this cross section needs a location. If cross section needs
a location, and does not have one set, an error is thrown at GetCrossSection |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetCrossSection |
Get a finished cross section from the builder. Checks whether cross section
has been build correctly and throws an exception if not.
|
| GetDepthDependence |
Return the depthdependence of the cross section currently being build
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| SetCoordinates |
Set the real world X-Y/easting-northing coordinates of the current cross section
|
| SetDefaultMarkers |
Set default markers if missing. This will set marker 1, 2 and 3, i.e., the lowest
point and left/right levee bank.
|
 | SetDefaultMarkers(XSBaseRaw) |
Set default markers if missing. This will set marker 1, 2 and 3, i.e., the lowest
point and left/right levee bank.
|
| SetEquidistantProcessingLevelSpecs(Int32) |
Sets equidistant processinglevel specs similar to those set in a MU setup
Builder pattern: Builds xsBaseRaw.
|
| SetEquidistantProcessingLevelSpecs(XSBaseRaw, Int32) |
Sets equidistant processinglevel specs similar to those set in a MU setup
Builder pattern: Builds xsBaseRaw.
|
| SetEquidistantProcessingLevelSpecs(Int32, Double, Double) |
Sets equidistant processinglevel specs similar to those set in a MU setup.
Use when the minimum and maximum Z-value of the raw data is known.
Builder pattern: Builds xsBaseRaw.
|
| SetEquidistantProcessingLevelSpecs(XSBaseRaw, Int32, Double, Double) |
Sets equidistant processinglevel specs similar to those set in a MU setup.
Use when the minimum and maximum Z-value of the raw data is known.
Builder pattern: Builds xsBaseRaw.
|
| SetFlowResistance |
Set the flow resistance of the cross section being build
|
| SetLeftLeveeBank |
The left levee bank (marker 1)
|
| SetLeftLowFlowBank |
The left low flow bank (marker 4).
|
| SetLocation |
Set the XLocation of the current cross section
|
| SetLowestPoint |
The lowest point in the channel (marker 2).
|
| SetProcessedData |
Set processed data. All arrays must have same length. Only
|
| SetRadiusType |
Set radius type of XSBaseRaw base cross section
|
| SetRawPoints |
Set raw data points.
It is setting the point list of an XSBaseRaw base cross section.
|
| SetResistanceDistribution |
Set the flow resistance of the cross section being build
|
| SetRightLeveeBank |
The right levee bank (marker 3).
|
| SetRightLowFlowBank |
The right low flow bank (marker 5).
|
| SetTopExtension |
Set top slotter on XSPolygon. The top slotter creates additional levels
in the processed data during XS initialize
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
See Also