C# Class BesAsm.Swsp.PacSizingTool.Facility

Class representing a stormwater mananagement facility
ファイルを表示 Open project: PDXBES/PacSizingTool Class Usage Examples

Protected Properties

Property 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

Public Methods

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

Protected Methods

Method 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

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

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

Facility() public method

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

ImportedMediumInfiltrationCapacityCfs() public method

The infiltration rate through imported soil in cfs
public ImportedMediumInfiltrationCapacityCfs ( ) : double
return double

NativeSoilInfiltrationCapacityCfs() public method

The infiltration rate through the native soil in cfs
public NativeSoilInfiltrationCapacityCfs ( ) : double
return double

Validate() public static method

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.
return bool

Property Details

_allowShapeSelection protected_oe property

protected bool _allowShapeSelection
return bool

_bottomAreaSqFt protected_oe property

protected double _bottomAreaSqFt
return double

_bottomPerimeterLengthFt protected_oe property

protected double _bottomPerimeterLengthFt
return double

_bottomWidthFt protected_oe property

protected double _bottomWidthFt
return double

_catchment protected_oe property

protected Catchment,BesAsm.Swsp.PacSizingTool _catchment
return Catchment

_configuration protected_oe property

protected FacilityConfiguration _configuration
return FacilityConfiguration

_freeboardIn protected_oe property

protected double _freeboardIn
return double

_growingMediumDepthIn protected_oe property

protected double _growingMediumDepthIn
return double

_hasCustomRockStorageBottomArea protected_oe property

protected bool _hasCustomRockStorageBottomArea
return bool

_hasRockInfluencedSurfaceStorage protected_oe property

protected bool _hasRockInfluencedSurfaceStorage
return bool

_hasRockStorage protected_oe property

protected bool _hasRockStorage
return bool

_hasSecondaryOverflow protected_oe property

protected bool _hasSecondaryOverflow
return bool

_isLined protected_oe property

protected bool _isLined
return bool

_rockStorageBottomAreaSqFt protected_oe property

protected double _rockStorageBottomAreaSqFt
return double

_rockStorageDepthIn protected_oe property

protected double _rockStorageDepthIn
return double

_rockVoidRatio protected_oe property

protected double _rockVoidRatio
return double

_sideSlopeRatio protected_oe property

protected double _sideSlopeRatio
return double

_specifySideSlope protected_oe property

protected bool _specifySideSlope
return bool

_storageDepth1In protected_oe property

protected double _storageDepth1In
return double

_storageDepth2In protected_oe property

protected double _storageDepth2In
return double

_storageDepth3In protected_oe property

protected double _storageDepth3In
return double

_surfaceAreaAtStorageDepth1SqFt protected_oe property

protected double _surfaceAreaAtStorageDepth1SqFt
return double

_surfaceAreaAtStorageDepth2SqFt protected_oe property

protected double _surfaceAreaAtStorageDepth2SqFt
return double

_type protected_oe property

protected FacilityType _type
return FacilityType