Click or drag to resize

XSPolygon Properties

The XSPolygon type exposes the following members.

Properties
  NameDescription
Public propertyAngle
Angle of correction between perpendicular (to river) and cross section orientation [radian].
(Inherited from XSBaseRaw.)
Public propertyApplyAngle
Flag specifying whether to apply Angle of correction.
(Inherited from XSBaseRaw.)
Public propertyAutoProcess
Automatically calculate processed data if 1) They are missing 2) They are not up-to-date (ProcessedDataStatus is NotUpdated)
(Inherited from XSBase.)
Public propertyBottomLevel
Lowest level/depth of the processed data. Note: ProcessedLevels must be defined
(Inherited from XSBase.)
Public propertyCrossSectionType
Type of cross section
(Inherited from XSBase.)
Public propertyEquidistantLevels
Flag to indicate whether equidistant levels are used.
(Inherited from XSBase.)
Public propertyFlowDir
Flow direction
(Inherited from XSBaseRaw.)
Public propertyFlowResistance
Flow resistance. Contains information on flow resistance type (ManningM or Chezy, Z dependence etc) and flow resistence values.
(Inherited from XSBase.)
Public propertyHasProcessedData (Inherited from XSBase.)
Public propertyHeight
Height of the cross section.
(Inherited from XSBase.)
Public propertyInterpolated
whether this cross section was generated from interpolation of neighboring cross sections
(Inherited from XSBaseRaw.)
Public propertyIsOpen
Return true if cross section is open
(Inherited from XSBaseRaw.)
Public propertyLeftCoordinateMarker
Point at left side of the cross section where the coordinate marker is located.
(Inherited from XSBaseRaw.)
Public propertyLeftLeveeBank
Point at left side of the cross section where the left levee is located.
(Inherited from XSBaseRaw.)
Public propertyLeftLowFlowBank
Point at left side of the cross section where the lowest flow bank is located.
(Inherited from XSBaseRaw.)
Public propertyLowestPoint
Point at lowest part of the cross section.
(Inherited from XSBaseRaw.)
Public propertyMaximumStorageWidth
Maximum storage width of the cross section
(Inherited from XSBaseRaw.)
Public propertyModifiedFormulation
Gets the Resistance Formulation that matches the GetResistanceFactor(Int32, Double) value.

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.

(Inherited from XSBase.)
Public propertyModifiedResistanceFactors
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.)
Public propertyMorphologicalDivision
When MorphologicalDivisionType is Level, specifies the level of morphological division

For ST modeling only.

Level is relative to raw data, and must not include any datum offset

(Inherited from XSBase.)
Public propertyMorphologicalDivisionType
Specifies the type of morphological division that is applied.

For ST modeling only.

(Inherited from XSBase.)
Public propertyNumberOfProcessedLevels
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.)
Public propertyPoints
List of points defining polygon cross section.
(Inherited from XSBaseRaw.)
Public propertyProcessedAdditionalSurfaceAreas
Processed additional storage area
(Inherited from XSBase.)
Public propertyProcessedAreas
Processed geometric areas
(Inherited from XSBase.)
Public propertyProcessedDataProtected
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.)
Public propertyProcessedDataStatus
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.)
Public propertyProcessedDerivatives
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.)
Public propertyProcessedFlowAreas
Processed flow areas
(Inherited from XSBase.)
Public propertyProcessedLevels
Processed levels
(Inherited from XSBase.)
Public propertyProcessedRadii
Processed radii
(Inherited from XSBase.)
Public propertyProcessedRadiiDerivatives
Processed radii
(Inherited from XSBase.)
Public propertyProcessedResistanceFactors
Processed resistance factors. Their type corresponds to the Resistance formulation specified in FlowResistance.
(Inherited from XSBase.)
Public propertyProcessedStorageWidths
Processed storage widths
(Inherited from XSBase.)
Public propertyProcessingLevelsSpecs
Access to all level-related specifications for pre-processing of cross section data
(Inherited from XSBase.)
Public propertyRadiusType
some kind of hydraulic or resistance radius
(Inherited from XSBaseRaw.)
Public propertyRelativeConveyanceCutoff
If processed data has been modified to assure that conveyance never decrease with increasing water levels, this value indicates at which level (relative to height) that the change started.

Only relevant for closed cross sections. Default value is 1.

(Inherited from XSBase.)
Public propertyRightCoordinateMarker
Point at right side of the cross section where the coordinate marker is located.
(Inherited from XSBaseRaw.)
Public propertyRightLeveeBank
Point at right side of the cross section where the right levee is located.
(Inherited from XSBaseRaw.)
Public propertyRightLowFlowBank
Point at right side of the cross section where the lowest flow bank is located.
(Inherited from XSBaseRaw.)
Public propertySelected
whether this cross section is selected for some operation, e.g. saving.
(Inherited from XSBaseRaw.)
Public propertySymmetric
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.)
Public propertyTopLevel
Highest level/depth of the processed data.
(Inherited from XSBase.)
Public propertyTopoID
The TopoID set that this cross section belongs to. TODO: See where for details?
(Inherited from XSBase.)
Top
See Also