C# Class Landis.Extension.BiomassHarvest.ParametersParser

A parser that reads the extension's parameters from text input.

Inheritance: Landis.Harvest.ParametersParser

Datei anzeigen Open project: LANDIS-II-Foundation/Extensions-Disturbance Class Usage Examples

Protected Properties

Property	Type	Description
namesThatFollowForestType	List

Public Methods

Method	Description
AgeOrRangeWasRead ( AgeRange ageRange, Edu.Wisc.Forest.Flel.Util.Percentage percentage ) : void
ParametersParser ( ISpeciesDataset speciesDataset ) : Edu.Wisc.Forest.Flel.Util	Initializes a new instance.
ParametersParser ( Landis.Species.Species speciesDataset, int scenarioStart, int scenarioEnd ) : Edu.Wisc.Forest.Flel.Util	Initializes a new instance.

Protected Methods

Method	Description
CreateCohortCutter ( ICohortSelector cohortSelector ) : ICohortCutter
CreateCohortSelectionMethodFor ( ISpecies species, IList ages, IList ranges ) : void	Creates a cohort selection method for a specific set of ages and age ranges. This overrides the base method so it can use the PartialThinning class to handle cohort selections with percentages.
CreateEmptyParameters ( ) : Landis.Library.HarvestManagement.InputParameters
Parse ( ) : Landis.Extension.BaseHarvest.IInputParameters
Parse ( ) : Landis.Harvest.IParameters
ReadBiomassMaps ( ) : void
ReadForestTypeTable ( IStandRankingMethod rankingMethod ) : void
ReadPrescriptions ( List prescriptions, int harvestTimestep ) : void	Reads 0 or more prescriptions from text input.
ReadSiteSelector ( ) : ISiteSelector
ReadSiteSelector ( Edu.Wisc.Forest.Flel.Util.StringReader reader, int &index ) : InputValue
ReplaceSpecificAgeSelectors ( ICohortSelector selector ) : MultiSpeciesCohortSelector
ReplaceSpecificAgeSelectors ( ICohortSelector selector ) : void
WrapSiteSelector ( ISiteSelector siteSelector ) : ISiteSelector

Private Methods

Method	Description
ParametersParser ( ) : Edu.Wisc.Forest.Flel.Util

Method Details

AgeOrRangeWasRead() public static method

public static AgeOrRangeWasRead ( AgeRange ageRange, Edu.Wisc.Forest.Flel.Util.Percentage percentage ) : void
ageRange	Landis.Harvest.AgeRange
percentage	Edu.Wisc.Forest.Flel.Util.Percentage
return	void

CreateCohortCutter() protected method

protected CreateCohortCutter ( ICohortSelector cohortSelector ) : ICohortCutter
cohortSelector	ICohortSelector
return	ICohortCutter

CreateCohortSelectionMethodFor() protected method

Creates a cohort selection method for a specific set of ages and age ranges.

This overrides the base method so it can use the PartialThinning class to handle cohort selections with percentages.

protected CreateCohortSelectionMethodFor ( ISpecies species, IList ages, IList ranges ) : void
species	ISpecies
ages	IList
ranges	IList
return	void

CreateEmptyParameters() protected method

protected CreateEmptyParameters ( ) : Landis.Library.HarvestManagement.InputParameters
return	Landis.Library.HarvestManagement.InputParameters

ParametersParser() public method

Initializes a new instance.

public ParametersParser ( ISpeciesDataset speciesDataset ) : Edu.Wisc.Forest.Flel.Util
speciesDataset	ISpeciesDataset	/// The dataset of species to look up species' names in. Important note: the base harvest /// speciesDataset must be overwritten with the HarvestSpeciesDataset. Methods within base harvest /// will set the MostRecentlyFetchedSpecies parameter when they are reading in species names /// from a list of cohorts to be removed. The value of MostRecentlyFetchedSpecies is not set within /// biomass harvest. ///
return	Edu.Wisc.Forest.Flel.Util

ParametersParser() public method

Initializes a new instance.

public ParametersParser ( Landis.Species.Species speciesDataset, int scenarioStart, int scenarioEnd ) : Edu.Wisc.Forest.Flel.Util
speciesDataset	Landis.Species.Species	/// The dataset of species to look up species' names in. ///
scenarioStart	int	/// The year that the model scenario starts. ///
scenarioEnd	int	/// The year that the model scenario ends. ///
return	Edu.Wisc.Forest.Flel.Util

Parse() protected method

protected Parse ( ) : Landis.Extension.BaseHarvest.IInputParameters
return	Landis.Extension.BaseHarvest.IInputParameters

Parse() protected method

protected Parse ( ) : Landis.Harvest.IParameters
return	Landis.Harvest.IParameters

ReadBiomassMaps() protected method

protected ReadBiomassMaps ( ) : void
return	void

ReadForestTypeTable() protected method

protected ReadForestTypeTable ( IStandRankingMethod rankingMethod ) : void
rankingMethod	IStandRankingMethod
return	void

ReadPrescriptions() protected method

Reads 0 or more prescriptions from text input.

protected ReadPrescriptions ( List prescriptions, int harvestTimestep ) : void
prescriptions	List
harvestTimestep	int
return	void

ReadSiteSelector() protected method

protected ReadSiteSelector ( ) : ISiteSelector
return	ISiteSelector

ReadSiteSelector() protected method

protected ReadSiteSelector ( Edu.Wisc.Forest.Flel.Util.StringReader reader, int &index ) : InputValue
reader	Edu.Wisc.Forest.Flel.Util.StringReader
index	int
return	InputValue

ReplaceSpecificAgeSelectors() protected method

protected ReplaceSpecificAgeSelectors ( ICohortSelector selector ) : MultiSpeciesCohortSelector
selector	ICohortSelector
return	Landis.Harvest.MultiSpeciesCohortSelector

ReplaceSpecificAgeSelectors() protected method

protected ReplaceSpecificAgeSelectors ( ICohortSelector selector ) : void
selector	ICohortSelector
return	void

WrapSiteSelector() protected method

protected WrapSiteSelector ( ISiteSelector siteSelector ) : ISiteSelector
siteSelector	ISiteSelector
return	ISiteSelector

Property Details

namesThatFollowForestType protected_oe static_oe property

protected static List namesThatFollowForestType
return	List