XSBase Properties |
The XSBase type exposes the following members.
Name | Description | |
---|---|---|
BottomLevel |
Lowest level/depth of the processed data.
Note: ProcessedLevels must be defined
| |
CrossSectionType |
Type of cross section
| |
FlowResistance |
Flow resistance. Contains information on flow resistance type
(ManningM or Chezy, Z dependence etc) and flow resistence values.
| |
Height |
Height of the cross section.
| |
Interpolated |
Returns true if the CrossSection is interpolated from other cross sections
| |
IsOpen |
Return true if cross section is open
| |
MaximumStorageWidth |
Maximum storage width of the cross section
| |
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. | |
ModifiedResistanceFactors |
Modified resistance factors. These will be different than ProcessedResistanceFactors
if one of the Multiply functions has been executed. This is matching the ModifiedFormulation | |
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.
| |
ProcessedAdditionalSurfaceAreas |
Processed additional storage area
| |
ProcessedAreas |
Processed geometric areas
| |
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.
| |
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.
| |
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)
| |
ProcessedFlowAreas |
Processed flow areas
| |
ProcessedLevels |
Processed levels
| |
ProcessedRadii |
Processed radii
| |
ProcessedRadiiDerivatives |
Processed radii
| |
ProcessedResistanceFactors |
Processed resistance factors. Their type corresponds to the
Resistance formulation specified in FlowResistance.
| |
ProcessedStorageWidths |
Processed storage widths
| |
ProcessingLevelsSpecs |
Access to all level-related specifications for pre-processing of cross section
data
| |
TopLevel |
Highest level/depth of the processed data.
| |
TopoID |
The TopoID set that this cross section belongs to. TODO: See where for details?
|