C# Class Landis.Harvest.AppliedPrescription

The application of a prescription to a management area.
Show file Open project: LANDIS-II-Foundation/Extensions-Disturbance

Public Methods

Method Description
AppliedPrescription ( Prescription prescription, ManagementArea managementArea, Edu.Wisc.Forest.Flel.Util.Percentage percentageToHarvest, int beginTime, int endTime ) : Edu.Wisc.Forest.Flel.Util
AppliedPrescription ( Prescription prescription, Edu.Wisc.Forest.Flel.Util.Percentage percentageToHarvest, int beginTime, int endTime ) : Edu.Wisc.Forest.Flel.Util
CompareRankings ( StandRanking x, StandRanking y ) : int

Compares two stand rankings such that the higher ranking comes before the lower ranking.
FinishInitialization ( int standCount ) : void

Finish initializing the applied prescription after reading the stand map.
FinishInitialization ( int standCount, double area ) : void

Finish initializing the applied prescription after reading the stand map. Determine the area size to harvest.
HarvestHighestRankedStand ( ) : void

Harvests the highest-ranked stand which hasn't been harvested yet during the current timestep.
InitializeForHarvest ( List stands ) : void

Initializes the prescription for harvesting, which includes computing stand rankings.

AreaRemainingToHarvest is set to AreaToHarvest, AreaRemainingRatio is set to 1.0, and AreaHarvested is set to 0.0.

Method Details

AppliedPrescription() public method

public AppliedPrescription ( Prescription prescription, ManagementArea managementArea, Edu.Wisc.Forest.Flel.Util.Percentage percentageToHarvest, int beginTime, int endTime ) : Edu.Wisc.Forest.Flel.Util
prescription Prescription
managementArea ManagementArea
percentageToHarvest Edu.Wisc.Forest.Flel.Util.Percentage
beginTime int
endTime int
return Edu.Wisc.Forest.Flel.Util

AppliedPrescription() public method

public AppliedPrescription ( Prescription prescription, Edu.Wisc.Forest.Flel.Util.Percentage percentageToHarvest, int beginTime, int endTime ) : Edu.Wisc.Forest.Flel.Util
prescription Prescription
percentageToHarvest Edu.Wisc.Forest.Flel.Util.Percentage
beginTime int
endTime int
return Edu.Wisc.Forest.Flel.Util

CompareRankings() public static method

Compares two stand rankings such that the higher ranking comes before the lower ranking.
public static CompareRankings ( StandRanking x, StandRanking y ) : int
x StandRanking
y StandRanking
return int

FinishInitialization() public method

Finish initializing the applied prescription after reading the stand map.
public FinishInitialization ( int standCount ) : void
standCount int /// The number of stands in the management area that the prescription /// is applied to. ///
return void

FinishInitialization() public method

Finish initializing the applied prescription after reading the stand map. Determine the area size to harvest.
public FinishInitialization ( int standCount, double area ) : void
standCount int /// The number of stands in the management area that the prescription /// is applied to. ///
area double /// The area count for which this prescription is to be applied. ///
return void

HarvestHighestRankedStand() public method

Harvests the highest-ranked stand which hasn't been harvested yet during the current timestep.
public HarvestHighestRankedStand ( ) : void
return void

InitializeForHarvest() public method

Initializes the prescription for harvesting, which includes computing stand rankings.
AreaRemainingToHarvest is set to AreaToHarvest, AreaRemainingRatio is set to 1.0, and AreaHarvested is set to 0.0.
public InitializeForHarvest ( List stands ) : void
stands List
return void