C# Class Landis.Harvest.ManagementArea

Management area is a collection of stands to which specific harvesting prescriptions are applied.

Show file Open project: LANDIS-II-Foundation/Extensions-Disturbance Class Usage Examples

Public Methods

Method	Description
Add ( Stand stand ) : void	Adds a stand to the management area.
ApplyPrescription ( Prescription prescription, Edu.Wisc.Forest.Flel.Util.Percentage percentageToHarvest, int startTime, int endTime ) : void	Adds a prescription to be applied to the management area.
FinishInitialization ( ) : void	Finish initializing the management area after reading the stand map. This phase of initialization includes computing the total area for the management area, and finishing the initialization of its applied prescriptions.
GetEnumerator ( ) : IEnumerator
HarvestStands ( ) : void	Harvest the area's stands according to its prescriptions.
IsApplied ( Prescription prescription ) : bool	Has a particular prescription been applied to the managment area?
IsApplied ( string prescriptionName, int beginTime, int endTime ) : bool	Has a particular prescription been applied to the managment area?
ManagementArea ( ushort mapCode ) : Edu.Wisc.Forest.Flel.Util

Method Details

Add() public method

Adds a stand to the management area.

public Add ( Stand stand ) : void
stand	Stand
return	void

ApplyPrescription() public method

Adds a prescription to be applied to the management area.

public ApplyPrescription ( Prescription prescription, Edu.Wisc.Forest.Flel.Util.Percentage percentageToHarvest, int startTime, int endTime ) : void
prescription	Prescription
percentageToHarvest	Edu.Wisc.Forest.Flel.Util.Percentage
startTime	int
endTime	int
return	void

FinishInitialization() public method

Finish initializing the management area after reading the stand map.

This phase of initialization includes computing the total area for the management area, and finishing the initialization of its applied prescriptions.

public FinishInitialization ( ) : void
return	void

GetEnumerator() public method

public GetEnumerator ( ) : IEnumerator
return	IEnumerator

HarvestStands() public method

Harvest the area's stands according to its prescriptions.

public HarvestStands ( ) : void
return	void

IsApplied() public method

Has a particular prescription been applied to the managment area?

public IsApplied ( Prescription prescription ) : bool
prescription	Prescription
return	bool

IsApplied() public method

Has a particular prescription been applied to the managment area?

public IsApplied ( string prescriptionName, int beginTime, int endTime ) : bool
prescriptionName	string
beginTime	int
endTime	int
return	bool

ManagementArea() public method

public ManagementArea ( ushort mapCode ) : Edu.Wisc.Forest.Flel.Util
mapCode	ushort
return	Edu.Wisc.Forest.Flel.Util