Click or drag to resize

XSBase Properties

The XSBase type exposes the following members.

Properties
  NameDescription
Public propertyAutoProcess
Automatically calculate processed data if 1) They are missing 2) They are not up-to-date (ProcessedDataStatus is NotUpdated)
Public propertyBottomLevel
Lowest level/depth of the processed data. Note: ProcessedLevels must be defined
Public propertyCrossSectionType
Type of cross section
Public propertyEquidistantLevels
Flag to indicate whether equidistant levels are used.
Public propertyFlowResistance
Flow resistance. Contains information on flow resistance type (ManningM or Chezy, Z dependence etc) and flow resistence values.
Public propertyHasProcessedData
Public propertyHeight
Height of the cross section.
Public propertyInterpolated
Returns true if the CrossSection is interpolated from other cross sections
Public propertyIsOpen
Return true if cross section is open
Public propertyMaximumStorageWidth
Maximum storage width of the cross section
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.

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
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

Public propertyMorphologicalDivisionType
Specifies the type of morphological division that is applied.

For ST modeling only.

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.
Public propertyProcessedAdditionalSurfaceAreas
Processed additional storage area
Public propertyProcessedAreas
Processed geometric areas
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.
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.
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)
Public propertyProcessedFlowAreas
Processed flow areas
Public propertyProcessedLevels
Processed levels
Public propertyProcessedRadii
Processed radii
Public propertyProcessedRadiiDerivatives
Processed radii
Public propertyProcessedResistanceFactors
Processed resistance factors. Their type corresponds to the Resistance formulation specified in FlowResistance.
Public propertyProcessedStorageWidths
Processed storage widths
Public propertyProcessingLevelsSpecs
Access to all level-related specifications for pre-processing of cross section data
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.

Public propertyTopLevel
Highest level/depth of the processed data.
Public propertyTopoID
The TopoID set that this cross section belongs to. TODO: See where for details?
Top
See Also