Click or drag to resize

XSBase Fields

The XSBase type exposes the following members.

Fields
  NameDescription
Protected field_bAutoProcess
Allow CalculateProcessedDataIfNeeded. Set to false to disable
Protected field_bProcessedDataProtected
false: data are not protected and will be recomputed. true: processed data are protected, data has been manually updated and will not be recomputed.
Protected field_crossSectionType
Type of cross section.
Protected field_distanceBetweenLevels
The distance between levels if equidistant levels are ued. If equidistant levels are used, then getIndex and getFraction are faster.
Protected field_equidistantLevels
Flag to indicate whether equidistant levels are used. If equidistant levels are used, then getIndex and getFraction are faster. Each derived cross section must set this flag to true (during construction), if it does not store levels in the _processedLevels array.
Protected field_flowResistance
Flow resistance
Protected field_height
Protected field_isInitialized
Protected field_isPrepared
Flag defining whether Prepare(Diagnostics, HDParameterData, ILocation) has been called.
Protected field_modifiedFormulation
Flow resistance formulation
Protected field_modifiedResistanceFactors
Modified resistance factors. As default points to _processedResistanceFactors, but during simulation contains resistance factors that are supported by the engine, which may differ from the original values.
Protected field_modifiedResistanceFactorsDerivatives
Processed resistance factor derivatives for the modified resistance factors.
Protected field_numberOfProcessedLevels
The number of processed levels
Protected field_originalProcessedData
A copy of original processed data, in case they have been modified by the engine during the simulation.
Protected field_processedAdditionalSurfaceAreas
Processed additional storage areas
Protected field_processedAreas
Processed geometric areas
Protected field_processedCriticalDischarges
Table with processed critical discharges, created automatically when required.
Protected field_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.
Protected field_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)
Protected field_processedFlowAreas
Processed flow ares
Protected field_processedLevels
Processed depths
Protected field_processedRadii
Processed radii
Protected field_processedRadiiDerivatives
Processed radius derivatives
Protected field_processedResistanceFactors
Processed resistance factors
Protected field_processedStorageWidths
Processed storage widths
Protected field_resistenceDistri
Resistance distribution
Top
See Also