XSPolygon Properties |
The XSPolygon type exposes the following members.
Name | Description | |
---|---|---|
Angle |
Angle of correction between perpendicular (to river) and cross section
orientation [radian].
(Inherited from XSBaseRaw.) | |
ApplyAngle |
Flag specifying whether to apply Angle of correction.
(Inherited from XSBaseRaw.) | |
BottomLevel |
Lowest level/depth of the processed data.
Note: ProcessedLevels must be defined
(Inherited from XSBase.) | |
CrossSectionType |
open, closed, circular, rectangular. Setter: a change in value to/from a regular
section clears all points. Setting to circular or rectangular creates a
default geometry of unit dimensions.
(Inherited from XSBaseRaw.) | |
FlowDir |
Flow direction
(Inherited from XSBaseRaw.) | |
FlowResistance |
Flow resistance. Contains information on flow resistance type
(ManningM or Chezy, Z dependence etc) and flow resistence values.
(Inherited from XSBase.) | |
Height |
Height of the cross section.
(Inherited from XSBase.) | |
Interpolated |
whether this cross section was generated from interpolation of neighboring
cross sections
(Inherited from XSBaseRaw.) | |
IsOpen |
Return true if cross section is open
(Inherited from XSBase.) | |
LeftCoordinateMarker |
Point at left side of the cross section where the coordinate marker is located.
(Inherited from XSBaseRaw.) | |
LeftLeveeBank |
Point at left side of the cross section where the left levee is located.
(Inherited from XSBaseRaw.) | |
LeftLowFlowBank |
Point at left side of the cross section where the lowest flow bank is located.
(Inherited from XSBaseRaw.) | |
LowestPoint |
Point at lowest part of the cross section.
(Inherited from XSBaseRaw.) | |
MaximumStorageWidth |
Maximum storage width of the cross section
(Inherited from XSBase.) | |
ModifiedFormulation |
Gets the Resistance Formulation that matches
the GetResistanceFactor(Int32, Double) value.
(Inherited from XSBase.)This is not necessarily the same as in FlowResistance. but can be different for several reasons: a) The raw and processed data differ, as for DarcyWeisbach. b) The resistance factors have been modified, and values used are those in ModifiedResistanceFactors. | |
ModifiedResistanceFactors |
Modified resistance factors. These will be different than ProcessedResistanceFactors
if one of the Multiply functions has been executed. This is matching the ModifiedFormulation (Inherited from XSBase.) | |
MorphologicalDivision |
for ST modeling only. DOUBLE_NaN if not used.
(Inherited from XSBaseRaw.) | |
NumberOfProcessedLevels |
returns the number of processed levels (same as dimension of all processed data
arrays). Returns 0 if processed data have not been calculated, yet.
(Inherited from XSBase.) | |
Points |
List of points defining polygon cross section.
(Inherited from XSBaseRaw.) | |
ProcessedAdditionalSurfaceAreas |
Processed additional storage area
(Inherited from XSBase.) | |
ProcessedAreas |
Processed geometric areas
(Inherited from XSBase.) | |
ProcessedDataProtected |
false: data are not protected and will be recomputed.
true: processed data are protected, data has been manually updated and will not be recomputed.
(Inherited from XSBase.) | |
ProcessedDataStatus |
ProcessingStatus defines the status of the processed data of this cross section.
Whenever the user updates raw data of the cross section, its state must be changed
to NotUpdated.
(Inherited from XSBase.) | |
ProcessedDerivatives |
Flag specifying whether processed derivatives are stored
as processed data arrays, or calculated directly. If true,
processed data arrays for the derivatives are created
(most accurate, smooth interpolation)
(Inherited from XSBase.) | |
ProcessedFlowAreas |
Processed flow areas
(Inherited from XSBase.) | |
ProcessedLevels |
Processed levels
(Inherited from XSBase.) | |
ProcessedRadii |
Processed radii
(Inherited from XSBase.) | |
ProcessedRadiiDerivatives |
Processed radii
(Inherited from XSBase.) | |
ProcessedResistanceFactors |
Processed resistance factors. Their type corresponds to the
Resistance formulation specified in FlowResistance.
(Inherited from XSBase.) | |
ProcessedStorageWidths |
Processed storage widths
(Inherited from XSBase.) | |
ProcessingLevelsSpecs |
Access to all level-related specifications for pre-processing of cross section
data
(Inherited from XSBase.) | |
RadiusType |
some kind of hydraulic or resistance radius
(Inherited from XSBaseRaw.) | |
RightCoordinateMarker |
Point at right side of the cross section where the coordinate marker is located.
(Inherited from XSBaseRaw.) | |
RightLeveeBank |
Point at right side of the cross section where the right levee is located.
(Inherited from XSBaseRaw.) | |
RightLowFlowBank |
Point at right side of the cross section where the lowest flow bank is located.
(Inherited from XSBaseRaw.) | |
Selected |
whether this cross section is selected for some operation, e.g. saving.
(Inherited from XSBaseRaw.) | |
Symmetric |
Determines if the points in this cross sections makes up one side of a symmetric cross section
Note: Not implemented yet
Note: Not always possible.
(Inherited from XSBaseRaw.) | |
TopLevel |
Highest level/depth of the processed data.
(Inherited from XSBase.) | |
TopoID |
The TopoID set that this cross section belongs to. TODO: See where for details?
(Inherited from XSBase.) |