C# Class BesAsm.Swsp.PacSizingTool.PacExecutor

Primary class for executing PAC calculations.

Show file Open project: PDXBES/PacSizingTool Class Usage Examples

Public Methods

Method	Description
CalculateSbuh10Year ( Catchment catchment ) : Hydrograph	Performs the SBUH calculations for the Ten-year storm event
CalculateSbuh25Year ( Catchment catchment ) : Hydrograph	Performs the SBUH calculations for the Twentyfive-year storm event
CalculateSbuh2Year ( Catchment catchment ) : Hydrograph	Performs the SBUH calculations for the Two-year storm event
CalculateSbuh5Year ( Catchment catchment ) : Hydrograph	Performs the SBUH calculations for the Five-year storm event
CalculateSbuhPr ( Catchment catchment ) : Hydrograph	Performs the SBUH calculations for the Pollution Reduction storm event
PerformCalculations ( Catchment catchment, Catchment preCatchment, Facility facility, int category ) : PacResults	Executes the calculator and returns a PacResults. Supports Category 4 facilities.
PerformCalculations ( Catchment catchment, Catchment preCatchment, Facility facility, int category, char dischargePoint ) : PacResults	Executes the calculator and returns a PacResults. Supports Category 3 facilities.
PerformCalculations ( Catchment catchment, Catchment preCatchment, SlopedFacility slopedFacility, int category ) : PacResults	Executes the calculator and returns a PacResults. Supports Category 4 facilities.
PerformCalculations ( Catchment catchment, Catchment preCatchment, SlopedFacility slopedFacility, int category, char dischargePoint ) : PacResults	Executes the calculator and returns a PacResults. Supports Category 3 facilities.
PerformCalculations ( Catchment catchment, Facility facility, int category ) : PacResults	Executes the calculator and returns a PacResults. Supports Category 1 and 2 facilities.
PerformCalculations ( Catchment catchment, SlopedFacility slopedFacility, int category ) : PacResults	Executes the calculator and returns a PacResults. Supports Category 1 and 2 facilities.
PerformSbuhCalcs ( Catchment catchment ) : PacResults	Executes only the SBUH calculations.

Private Methods

Method	Description
PerformCalculations ( Catchment catchment, Catchment preCatchment, Facility facility, HierarchyCategory category, DischargePoint dischargePoint ) : PacResults	Executes the calculator and returns a PacResults.

Method Details

CalculateSbuh10Year() public static method

Performs the SBUH calculations for the Ten-year storm event

public static CalculateSbuh10Year ( Catchment catchment ) : Hydrograph
catchment	Catchment	A Catchment object
return	Hydrograph

CalculateSbuh25Year() public static method

Performs the SBUH calculations for the Twentyfive-year storm event

public static CalculateSbuh25Year ( Catchment catchment ) : Hydrograph
catchment	Catchment	A Catchment object
return	Hydrograph

CalculateSbuh2Year() public static method

Performs the SBUH calculations for the Two-year storm event

public static CalculateSbuh2Year ( Catchment catchment ) : Hydrograph
catchment	Catchment	A Catchment object
return	Hydrograph

CalculateSbuh5Year() public static method

Performs the SBUH calculations for the Five-year storm event

public static CalculateSbuh5Year ( Catchment catchment ) : Hydrograph
catchment	Catchment	A Catchment object
return	Hydrograph

CalculateSbuhPr() public static method

Performs the SBUH calculations for the Pollution Reduction storm event

public static CalculateSbuhPr ( Catchment catchment ) : Hydrograph
catchment	Catchment	A Catchment object
return	Hydrograph

PerformCalculations() public static method

Executes the calculator and returns a PacResults. Supports Category 4 facilities.

public static PerformCalculations ( Catchment catchment, Catchment preCatchment, Facility facility, int category ) : PacResults
catchment	Catchment	A catchment object defining the hydrologic parameters of the catchment area to be evaluated.
preCatchment	Catchment	A catchment object defining the hydrologic parameters of the pre-developed catchment area to be evaluated.
facility	Facility	A Facility object defining the stormwater management facility to be evaluated.
category	int	Identifies the Hierarchy Category the proposed facility will be evaluated against. Must be an integer from 1 to 4.
return	PacResults

PerformCalculations() public static method

Executes the calculator and returns a PacResults. Supports Category 3 facilities.

public static PerformCalculations ( Catchment catchment, Catchment preCatchment, Facility facility, int category, char dischargePoint ) : PacResults
catchment	Catchment	A catchment object defining the hydrologic parameters of the catchment area to be evaluated.
preCatchment	Catchment	A catchment object defining the hydrologic parameters of the pre-developed catchment area to be evaluated.
facility	Facility	A Facility object defining the stormwater management facility to be evaluated.
category	int	Identifies the Hierarchy Category the proposed facility will be evaluated against. Must be an integer from 1 to 4.
dischargePoint	char	Identifies the DischargePoint of the proposed facility.
return	PacResults

PerformCalculations() public static method

Executes the calculator and returns a PacResults. Supports Category 4 facilities.

public static PerformCalculations ( Catchment catchment, Catchment preCatchment, SlopedFacility slopedFacility, int category ) : PacResults
catchment	Catchment	A catchment object defining the hydrologic parameters of the catchment area to be evaluated.
preCatchment	Catchment	A catchment object defining the hydrologic parameters of the pre-developed catchment area to be evaluated.
slopedFacility	SlopedFacility	A SlopedFacility object defining the stormwater management facility to be evaluated.
category	int	Identifies the Hierarchy Category the proposed facility will be evaluated against. Must be an integer from 1 to 4.
return	PacResults

PerformCalculations() public static method

Executes the calculator and returns a PacResults. Supports Category 3 facilities.

public static PerformCalculations ( Catchment catchment, Catchment preCatchment, SlopedFacility slopedFacility, int category, char dischargePoint ) : PacResults
catchment	Catchment	A catchment object defining the hydrologic parameters of the catchment area to be evaluated.
preCatchment	Catchment	A catchment object defining the hydrologic parameters of the pre-developed catchment area to be evaluated.
slopedFacility	SlopedFacility	A SlopedFacility object defining the stormwater management facility to be evaluated.
category	int	Identifies the Hierarchy Category the proposed facility will be evaluated against. Must be an integer from 1 to 4.
dischargePoint	char	Identifies the DischargePoint of the proposed facility.
return	PacResults

PerformCalculations() public static method

Executes the calculator and returns a PacResults. Supports Category 1 and 2 facilities.

public static PerformCalculations ( Catchment catchment, Facility facility, int category ) : PacResults
catchment	Catchment	A catchment object defining the hydrologic parameters of the catchment area to be evaluated.
facility	Facility	A Facility object defining the stormwater management facility to be evaluated.
category	int	Identifies the Hierarchy Category the proposed facility will be evaluated against. Must be an integer from 1 to 4.
return	PacResults

PerformCalculations() public static method

Executes the calculator and returns a PacResults. Supports Category 1 and 2 facilities.

public static PerformCalculations ( Catchment catchment, SlopedFacility slopedFacility, int category ) : PacResults
catchment	Catchment	A catchment object defining the hydrologic parameters of the catchment area to be evaluated.
slopedFacility	SlopedFacility	A SlopedFacility object defining the stormwater management facility to be evaluated.
category	int	Identifies the Hierarchy Category the proposed facility will be evaluated against. Must be an integer from 1 to 4.
return	PacResults

PerformSbuhCalcs() public static method

Executes only the SBUH calculations.

public static PerformSbuhCalcs ( Catchment catchment ) : PacResults
catchment	Catchment	The catchment to calculate the SBUH results.
return	PacResults