XSCircular Properties

Properties

AutoProcess Automatically calculate processed data if 1) They are missing 2) They are not up-to-date (ProcessedDataStatus is NotUpdated)
(Inherited from XSBase)
BottomLevel Lowest level/depth of the processed data. Note: ProcessedLevels must be defined
(Inherited from XSBase)
CrossSectionType Type of cross section
(Inherited from XSBase)
Diameter Diameter of cross section
EquidistantLevels Flag to indicate whether equidistant levels are used.
(Inherited from XSBase)
FlowResistance Flow resistance. Contains information on flow resistance type (ManningM or Chezy, Z dependence etc) and flow resistence values.
(Inherited from XSBase)
HasProcessedData
(Inherited from XSBase)
Height Height of the cross section
(Overrides XSBaseHeight)
Interpolated Returns true if the CrossSection is interpolated from other cross sections
(Inherited from XSBase)
Obsolete
IsOpen Return true if cross section is open
(Inherited from XSBase)
MaximumStorageWidth Maximum storage width of the cross section
(Overrides XSBaseMaximumStorageWidth)
ModifiedFormulation 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)
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 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)
MorphologicalDivisionType Specifies the type of morphological division that is applied.

For ST modeling only.


(Inherited from XSBase)
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)
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)
RelativeConveyanceCutoff 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)
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)

See Also