C# Class BesAsm.Swsp.PacSizingTool.Facility

Class representing a stormwater mananagement facility
Afficher le fichier Open project: PDXBES/PacSizingTool Class Usage Examples

Protected Properties

Свойство Type Description
_allowShapeSelection bool
_bottomAreaSqFt double
_bottomPerimeterLengthFt double
_bottomWidthFt double
_catchment Catchment
_configuration FacilityConfiguration
_freeboardIn double
_growingMediumDepthIn double
_hasCustomRockStorageBottomArea bool
_hasRockInfluencedSurfaceStorage bool
_hasRockStorage bool
_hasSecondaryOverflow bool
_isLined bool
_rockStorageBottomAreaSqFt double
_rockStorageDepthIn double
_rockVoidRatio double
_sideSlopeRatio double
_specifySideSlope bool
_storageDepth1In double
_storageDepth2In double
_storageDepth3In double
_surfaceAreaAtStorageDepth1SqFt double
_surfaceAreaAtStorageDepth2SqFt double
_type FacilityType

Méthodes publiques

Méthode Description
Facility ( FacilityType type, FacilityConfiguration configuration, Catchment catchment ) : System

Constructs a new Facility object of the specified Type and Configuration, located within the specified Catchment

ImportedMediumInfiltrationCapacityCfs ( ) : double

The infiltration rate through imported soil in cfs

NativeSoilInfiltrationCapacityCfs ( ) : double

The infiltration rate through the native soil in cfs

Validate ( Facility facility, int category, string &message ) : bool

Performs checks to determine whether a Facility has required parameters assigned, and that all parameters are valid.

Méthodes protégées

Méthode Description
ConfigureFacility ( ) : void

Based on the facility configuration, sets appropriate boolean values. For instance, Facility Configuration A and D do not have rock storage, thus, _hasRockStorage is set to "false".

Private Methods

Méthode Description
CalculateVolume ( double depthIn ) : double

Utility method to calculate the volume of basins and flat planters

SurfaceAreaAtDepth ( double depthIn ) : double

Utility method to calculate the surface area of facilities filled to a certain depth, ignorant of overflows.

Method Details

ConfigureFacility() protected méthode

Based on the facility configuration, sets appropriate boolean values. For instance, Facility Configuration A and D do not have rock storage, thus, _hasRockStorage is set to "false".
protected ConfigureFacility ( ) : void
Résultat void

Facility() public méthode

Constructs a new Facility object of the specified Type and Configuration, located within the specified Catchment
public Facility ( FacilityType type, FacilityConfiguration configuration, Catchment catchment ) : System
type FacilityType The type of facility
configuration FacilityConfiguration The plumbed facility configuration
catchment Catchment The Catchment containing the facility
Résultat System

ImportedMediumInfiltrationCapacityCfs() public méthode

The infiltration rate through imported soil in cfs
public ImportedMediumInfiltrationCapacityCfs ( ) : double
Résultat double

NativeSoilInfiltrationCapacityCfs() public méthode

The infiltration rate through the native soil in cfs
public NativeSoilInfiltrationCapacityCfs ( ) : double
Résultat double

Validate() public static méthode

Performs checks to determine whether a Facility has required parameters assigned, and that all parameters are valid.
public static Validate ( Facility facility, int category, string &message ) : bool
facility Facility The Facility to validate
category int The Hierarchy Category the facility will be validated against
message string A message indicating the first error found in an invalid facility, /// or "Valid Configuration" if the facility is valid.
Résultat bool

Property Details

_allowShapeSelection protected_oe property

protected bool _allowShapeSelection
Résultat bool

_bottomAreaSqFt protected_oe property

protected double _bottomAreaSqFt
Résultat double

_bottomPerimeterLengthFt protected_oe property

protected double _bottomPerimeterLengthFt
Résultat double

_bottomWidthFt protected_oe property

protected double _bottomWidthFt
Résultat double

_catchment protected_oe property

protected Catchment,BesAsm.Swsp.PacSizingTool _catchment
Résultat Catchment

_configuration protected_oe property

protected FacilityConfiguration _configuration
Résultat FacilityConfiguration

_freeboardIn protected_oe property

protected double _freeboardIn
Résultat double

_growingMediumDepthIn protected_oe property

protected double _growingMediumDepthIn
Résultat double

_hasCustomRockStorageBottomArea protected_oe property

protected bool _hasCustomRockStorageBottomArea
Résultat bool

_hasRockInfluencedSurfaceStorage protected_oe property

protected bool _hasRockInfluencedSurfaceStorage
Résultat bool

_hasRockStorage protected_oe property

protected bool _hasRockStorage
Résultat bool

_hasSecondaryOverflow protected_oe property

protected bool _hasSecondaryOverflow
Résultat bool

_isLined protected_oe property

protected bool _isLined
Résultat bool

_rockStorageBottomAreaSqFt protected_oe property

protected double _rockStorageBottomAreaSqFt
Résultat double

_rockStorageDepthIn protected_oe property

protected double _rockStorageDepthIn
Résultat double

_rockVoidRatio protected_oe property

protected double _rockVoidRatio
Résultat double

_sideSlopeRatio protected_oe property

protected double _sideSlopeRatio
Résultat double

_specifySideSlope protected_oe property

protected bool _specifySideSlope
Résultat bool

_storageDepth1In protected_oe property

protected double _storageDepth1In
Résultat double

_storageDepth2In protected_oe property

protected double _storageDepth2In
Résultat double

_storageDepth3In protected_oe property

protected double _storageDepth3In
Résultat double

_surfaceAreaAtStorageDepth1SqFt protected_oe property

protected double _surfaceAreaAtStorageDepth1SqFt
Résultat double

_surfaceAreaAtStorageDepth2SqFt protected_oe property

protected double _surfaceAreaAtStorageDepth2SqFt
Résultat double

_type protected_oe property

protected FacilityType _type
Résultat FacilityType