This class encapsulates the data for a single harvest event - being for one timestep, for one cut type. More...

Public Member Functions
	HarvestData (float fXCellLength, float fYCellLength)
	Constructor. More...

float	getXCellLength ()
	Gets the length of the cells in the X direction that define the area of this event. More...

float	getYCellLength ()
	Gets the length of the cells in the Y direction that define the area of this event. More...

void	setXCellLength (float fXCellLength)
	Sets the length of the cells in the X direction that define the area of this event. More...

void	setYCellLength (float fYCellLength)
	Sets the length of the cells in the Y direction that define the area of this event. More...

int	getCutAmountType ()
	Gets the cut amount type. More...

void	setCutAmountType (int iCut) throws ModelException
	Sets the cut amount type. More...

int	getCutType ()
	Gets the cut type. More...

void	setCutType (int iCut) throws ModelException
	Sets the cut type. More...

String	getPriority1Name ()
	Gets the data member name for the first cut priority. More...

String	getPriority2Name ()
	Gets the data member name for the second cut priority. More...

String	getPriority3Name ()
	Gets the data member name for the third cut priority. More...

float	getPriority1Min ()
	Gets the minimum value for the first cut priority. More...

float	getPriority2Min ()
	Gets the minimum value for the second cut priority. More...

float	getPriority3Min ()
	Gets the minimum value for the third cut priority. More...

float	getPriority1Max ()
	Gets the maximum value for the first cut priority. More...

float	getPriority2Max ()
	Gets the maximum value for the second cut priority. More...

float	getPriority3Max ()
	Gets the maximum value for the third cut priority. More...

int	getPriority1Type ()
	Gets the data member type for the first cut priority. More...

int	getPriority2Type ()
	Gets the data member type for the second cut priority. More...

int	getPriority3Type ()
	Gets the data member type for the third cut priority. More...

void	writePriority1XML (BufferedWriter jOut) throws IOException
	Writes XML for the first priority. More...

void	writePriority2XML (BufferedWriter jOut) throws IOException
	Writes XML for the second priority. More...

void	writePriority3XML (BufferedWriter jOut) throws IOException
	Writes XML for the third priority. More...

void	setPriority1 (String sPriorityName, float fMin, float fMax, int iType)
	Sets priority 1 information. More...

void	setPriority2 (String sPriorityName, float fMin, float fMax, int iType)
	Sets priority 2 information. More...

void	setPriority3 (String sPriorityName, float fMin, float fMax, int iType)
	Sets priority 3 information. More...

int	getTimestep ()
	Gets the timestep for this cut event. More...

void	setTimestep (int iTimestep) throws ModelException
	Sets the timestep for this cut event. More...

int	getNumberOfSpecies ()
	Gets the number of species to which this cut has been applied. More...

int	getSpecies (int iIndex) throws ModelException
	Gets a species at a certain index within the species list. More...

void	setSeedlingMortRate (int iSpecies, float fRate)
	Sets the seedling mortality rate for a species. More...

float	getSeedlingMortRate (int iSpecies)
	Gets the seedling mortality rate for a species. More...

int	getSeedlingMortRateSize ()
	Returns the number of set seedling mortality rates. More...

void	addSpecies (int iSpecies)
	Adds a new species to apply this harvest cut to. More...

void	removeSpecies (int iSpecies)
	Removes a species from the list to which to apply this harvest. More...

void	clearSpecies ()
	Clears the list of species. More...

int	getNumberOfCutRanges ()
	Gets the number of cut ranges. More...

void	addCutRange (float fLow, float fHigh, float fAmountToCut) throws ModelException
	Adds a new cut range. More...

float	getLowerBound (int iCutRangeIndex) throws ModelException
	Gets the lower dbh bound value for a cut range. More...

boolean	getTallestFirstFlag ()
	Gets the flag for whether to cut tallest-to-smallest (true) or smallest- to-tallest (false). More...

void	setTallestFirstFlag (boolean bFlag)
	Sets the flag for whether to cut tallest-to-smallest (true) or smallest- to-tallest (false). More...

float	getUpperBound (int iCutRangeIndex) throws ModelException
	Gets the upper dbh bound value for a cut range. More...

float	getCutAmount (int iCutRangeIndex) throws ModelException
	Gets the cut amount for a cut range. More...

int	getNumberOfCells ()
	Gets the number of cells in the cut range's cut area. More...

void	addCell (int iX, int iY, Plot oPlot) throws ModelException
	Adds a cell to the harvest cut range's area. More...

void	addCell (Cell oNewCell)
	Adds a cell to the harvest cut range's area. More...

void	removeCell (int iIndex)
	Removes a cell from the harvest cut range's area. More...

void	removeAllCells ()
	Deletes all cells. More...

Cell	getCell (int iIndex) throws ModelException
	Gets a cell in a harvest's cut area. More...

void	validateCut (TreePopulation oPop, Plot oPlot) throws ModelException
	Validates the current set of data in this cut. More...

void	updateCellsNewGridResolution (float fNewXCellLength, float fNewYCellLength, Plot oPlot) throws ModelException
	Adjusts any existing cell lists in response to grid cell changes. More...

Object	clone ()
	Makes a clone of this object. More...

Static Public Attributes
static final int	PERCENTAGE_BASAL_AREA = 2
	Percentage basal area. More...

static final int	ABSOLUTE_BASAL_AREA = 3
	Absolute basal area. More...

static final int	PERCENTAGE_DENSITY = 0
	Percentage density. More...

static final int	ABSOLUTE_DENSITY = 1
	Absolute density. More...

static final int	PARTIAL_CUT = 1
	Partial cut. More...

static final int	GAP_CUT = 2
	Gap cut. More...

static final int	CLEAR_CUT = 3
	Clear cut. More...

static int	NUMBER_ALLOWED_CUT_RANGES = 4
	Maximum number of allowed cut ranges. More...

Private Attributes
ArrayList< Integer >	mp_iSpecies = new ArrayList<Integer>(0)
	Species codes to which to apply this harvest cut. More...

ArrayList< Cell >	mp_oCells = new ArrayList<Cell>(0)
	The list of cells to which to apply this cut (vector of Cell objects) More...

ArrayList< CutRange >	mp_oCutRanges = new ArrayList<CutRange>(0)
	The list of cut ranges and cut amounts (CutRange objects) More...

ArrayList< Float >	mp_fSeedlingMortRate = new ArrayList<Float>(0)
	Seedling mortality rate. More...

float	m_fXCellLength
	Length of cells in the X direction. More...

float	m_fYCellLength
	Length of cells in the Y direction. More...

int	m_iTimestep = -1
	Timestep to which to apply this harvest cut. More...

int	m_iCutType = -1
	The cut type - possible values come from DisturbanceBehaviors and are PARTIAL_CUT, GAP_CUT, and CLEAR_CUT. More...

int	m_iCutAmountType = -1
	How the cut amount is specified - possible values come from DisturbanceBehaviors and are PERCENTAGE_BASAL_AREA, ABSOLUTE_BASAL_AREA, PERCENTAGE_DENSITY, and ABSOLUTE_DENSITY. More...

boolean	m_bTallestFirst = true
	Flag for whether to cut tallest-to-smallest (true) or smallest-to-tallest (false. More...

CutPriority	m_oPriority1 = new CutPriority()
	First cut priority. More...

CutPriority	m_oPriority2 = new CutPriority()
	Second cut priority. More...

CutPriority	m_oPriority3 = new CutPriority()
	Third cut priority. More...

Detailed Description

This class encapsulates the data for a single harvest event - being for one timestep, for one cut type.

Copyright: Copyright (c) Charles D. Canham 2003

Company: Cary Institute of Ecosystem Studies

Author: Lora E. Murphy

Version: 1.0

Edit history:
---------------—
December 8, 2011: Wiped the slate clean for version 7 (LEM)
May 12, 2017: Added flag for cut smallest-to-tallest

Constructor & Destructor Documentation

◆ HarvestData()

sortie.data.funcgroups.disturbance.HarvestData.HarvestData	(	float	fXCellLength,
		float	fYCellLength
	)

Constructor.

Parameters

fXCellLength	Length of cells in the X direction.
fYCellLength	Length of cells in the Y direction.

Member Function Documentation

◆ addCell() [1/2]

void sortie.data.funcgroups.disturbance.HarvestData.addCell	(	int	iX,
		int	iY,
		Plot	oPlot
	)		throws ModelException

Adds a cell to the harvest cut range's area.

Duplicates will not be added.

Parameters

iX	X cell number.
iY	Y cell number.
oPlot	a Plot object.

Exceptions

ModelException if the cell coordinates are invalid.

◆ addCell() [2/2]

void sortie.data.funcgroups.disturbance.HarvestData.addCell ( Cell oNewCell )

Adds a cell to the harvest cut range's area.

Duplicates will not be added.

Parameters

oNewCell Cell object to add.

◆ addCutRange()

void sortie.data.funcgroups.disturbance.HarvestData.addCutRange	(	float	fLow,
		float	fHigh,
		float	fAmountToCut
	)		throws ModelException

Adds a new cut range.

Parameters

fLow	Lower bound of the cut range, as a dbh in cm.
fHigh	Upper bound of the cut range, as a dbh in cm.
fAmountToCut	Amount to cut. If the amount cut type is as a percentage of either basal area or density, this is a percentage value between 0 and 100. If it is amount of basal area, this is basal area in square meters per hectare. If this is amount of density, this is number of trees per hectare.

Exceptions

ModelException

if any of the following are true:

This adds more than the maximum number of cut ranges allowed
A dbh bound value is less than 0
The upper bound value is less than the lower bound value
The amount to cut is negative
If the amount to cut is a percentage, the value is either less than 0 or greater than 100

◆ addSpecies()

void sortie.data.funcgroups.disturbance.HarvestData.addSpecies ( int iSpecies )

Adds a new species to apply this harvest cut to.

If this species is already on the list, it is not added again.

Parameters

iSpecies Species index.

◆ clearSpecies()

void sortie.data.funcgroups.disturbance.HarvestData.clearSpecies ( )

Clears the list of species.

◆ clone()

Object sortie.data.funcgroups.disturbance.HarvestData.clone ( )

Makes a clone of this object.

Returns: Clone.

◆ getCell()

Cell sortie.data.funcgroups.disturbance.HarvestData.getCell ( int iIndex ) throws ModelException

Gets a cell in a harvest's cut area.

Parameters

iIndex The index of the object.

Returns: The cell object.

Exceptions

ModelException If the index is not valid.

◆ getCutAmount()

float sortie.data.funcgroups.disturbance.HarvestData.getCutAmount ( int iCutRangeIndex ) throws ModelException

Gets the cut amount for a cut range.

Parameters

iCutRangeIndex The cut range index.

Returns: The cut amount.

Exceptions

ModelException If the cut range is invalid.

◆ getCutAmountType()

int sortie.data.funcgroups.disturbance.HarvestData.getCutAmountType ( )

Gets the cut amount type.

Possible values come from DisturbanceBehaviors and are PERCENTAGE_BASAL_AREA, ABSOLUTE_BASAL_AREA, PERCENTAGE_DENSITY, and ABSOLUTE_DENSITY, or -1 if the value has not yet been set.

Returns: The cut amount type.

◆ getCutType()

int sortie.data.funcgroups.disturbance.HarvestData.getCutType ( )

Gets the cut type.

Returns: The cut type. Possible values come from DisturbanceBehaviors and are PARTIAL_CUT, GAP_CUT, and CLEAR_CUT, or -1 if the value has not been set.

◆ getLowerBound()

float sortie.data.funcgroups.disturbance.HarvestData.getLowerBound ( int iCutRangeIndex ) throws ModelException

Gets the lower dbh bound value for a cut range.

Parameters

iCutRangeIndex The cut range index.

Returns: The lower bound.

Exceptions

ModelException If the cut range is invalid.

◆ getNumberOfCells()

int sortie.data.funcgroups.disturbance.HarvestData.getNumberOfCells ( )

Gets the number of cells in the cut range's cut area.

Returns: Number of cells.

◆ getNumberOfCutRanges()

int sortie.data.funcgroups.disturbance.HarvestData.getNumberOfCutRanges ( )

Gets the number of cut ranges.

Returns: Number of cut ranges.

◆ getNumberOfSpecies()

int sortie.data.funcgroups.disturbance.HarvestData.getNumberOfSpecies ( )

Gets the number of species to which this cut has been applied.

Returns: The number of species.

◆ getPriority1Max()

float sortie.data.funcgroups.disturbance.HarvestData.getPriority1Max ( )

Gets the maximum value for the first cut priority.

Returns: Data member maximum value.

◆ getPriority1Min()

float sortie.data.funcgroups.disturbance.HarvestData.getPriority1Min ( )

Gets the minimum value for the first cut priority.

Returns: Data member minimum value.

◆ getPriority1Name()

String sortie.data.funcgroups.disturbance.HarvestData.getPriority1Name ( )

Gets the data member name for the first cut priority.

Returns: Data member name, or empty string if no priority assigned.

◆ getPriority1Type()

int sortie.data.funcgroups.disturbance.HarvestData.getPriority1Type ( )

Gets the data member type for the first cut priority.

Returns: Data member type.

◆ getPriority2Max()

float sortie.data.funcgroups.disturbance.HarvestData.getPriority2Max ( )

Gets the maximum value for the second cut priority.

Returns: Data member maximum value.

◆ getPriority2Min()

float sortie.data.funcgroups.disturbance.HarvestData.getPriority2Min ( )

Gets the minimum value for the second cut priority.

Returns: Data member minimum value.

◆ getPriority2Name()

String sortie.data.funcgroups.disturbance.HarvestData.getPriority2Name ( )

Gets the data member name for the second cut priority.

Returns: Data member name, or empty string if no priority assigned.

◆ getPriority2Type()

int sortie.data.funcgroups.disturbance.HarvestData.getPriority2Type ( )

Gets the data member type for the second cut priority.

Returns: Data member type.

◆ getPriority3Max()

float sortie.data.funcgroups.disturbance.HarvestData.getPriority3Max ( )

Gets the maximum value for the third cut priority.

Returns: Data member maximum value.

◆ getPriority3Min()

float sortie.data.funcgroups.disturbance.HarvestData.getPriority3Min ( )

Gets the minimum value for the third cut priority.

Returns: Data member minimum value.

◆ getPriority3Name()

String sortie.data.funcgroups.disturbance.HarvestData.getPriority3Name ( )

Gets the data member name for the third cut priority.

Returns: Data member name, or empty string if no priority assigned.

◆ getPriority3Type()

int sortie.data.funcgroups.disturbance.HarvestData.getPriority3Type ( )

Gets the data member type for the third cut priority.

Returns: Data member type.

◆ getSeedlingMortRate()

float sortie.data.funcgroups.disturbance.HarvestData.getSeedlingMortRate ( int iSpecies )

Gets the seedling mortality rate for a species.

Parameters

iSpecies Species to set.

Returns: Mortality rate.

◆ getSeedlingMortRateSize()

int sortie.data.funcgroups.disturbance.HarvestData.getSeedlingMortRateSize ( )

Returns the number of set seedling mortality rates.

A useful check to see if any were read.

Returns: The size of the vector for seedling mortality rate.

◆ getSpecies()

int sortie.data.funcgroups.disturbance.HarvestData.getSpecies ( int iIndex ) throws ModelException

Gets a species at a certain index within the species list.

Parameters

iIndex The species index.

Returns: The species value.

Exceptions

ModelException If the index is not valid.

◆ getTallestFirstFlag()

boolean sortie.data.funcgroups.disturbance.HarvestData.getTallestFirstFlag ( )

Gets the flag for whether to cut tallest-to-smallest (true) or smallest- to-tallest (false).

Returns: Tallest-to-smallest flag.

◆ getTimestep()

int sortie.data.funcgroups.disturbance.HarvestData.getTimestep ( )

Gets the timestep for this cut event.

Returns: The timestep.

◆ getUpperBound()

float sortie.data.funcgroups.disturbance.HarvestData.getUpperBound ( int iCutRangeIndex ) throws ModelException

Gets the upper dbh bound value for a cut range.

Parameters

iCutRangeIndex The cut range index.

Returns: The upper bound.

Exceptions

ModelException If the cut range is invalid.

◆ getXCellLength()

float sortie.data.funcgroups.disturbance.HarvestData.getXCellLength ( )

Gets the length of the cells in the X direction that define the area of this event.

Returns: Length of the cells.

◆ getYCellLength()

float sortie.data.funcgroups.disturbance.HarvestData.getYCellLength ( )

Gets the length of the cells in the Y direction that define the area of this event.

Returns: Length of the cells.

◆ removeAllCells()

void sortie.data.funcgroups.disturbance.HarvestData.removeAllCells ( )

Deletes all cells.

◆ removeCell()

void sortie.data.funcgroups.disturbance.HarvestData.removeCell ( int iIndex )

Removes a cell from the harvest cut range's area.

Parameters

iIndex int Cell index. Invalid values are ignored.

◆ removeSpecies()

void sortie.data.funcgroups.disturbance.HarvestData.removeSpecies ( int iSpecies )

Removes a species from the list to which to apply this harvest.

If this species is not on the list, the function quietly exits.

Parameters

iSpecies Species number (number identifying the species, NOT the index number in the vector).

◆ setCutAmountType()

void sortie.data.funcgroups.disturbance.HarvestData.setCutAmountType ( int iCut ) throws ModelException

Sets the cut amount type.

Parameters

iCut	the cut amount type. Possible values come from DisturbanceBehaviors and are PERCENTAGE_BASAL_AREA, ABSOLUTE_BASAL_AREA, PERCENTAGE_DENSITY, and ABSOLUTE_DENSITY.

Exceptions

ModelException if the cut amount type is unrecognized.

◆ setCutType()

void sortie.data.funcgroups.disturbance.HarvestData.setCutType ( int iCut ) throws ModelException

Sets the cut type.

Parameters

iCut	The cut type. Values come from DisturbanceBehaviors and are PARTIAL_CUT, GAP_CUT, and CLEAR_CUT.

Exceptions

ModelException if the cut type is unrecognized.

◆ setPriority1()

void sortie.data.funcgroups.disturbance.HarvestData.setPriority1	(	String	sPriorityName,
		float	fMin,
		float	fMax,
		int	iType
	)

Sets priority 1 information.

Parameters

sPriorityName	Priority name
fMin	Min value
fMax	Max value
iType	Type, from DataMember: FLOAT, INTEGER, or BOOLEAN

◆ setPriority2()

void sortie.data.funcgroups.disturbance.HarvestData.setPriority2	(	String	sPriorityName,
		float	fMin,
		float	fMax,
		int	iType
	)

Sets priority 2 information.

Parameters

sPriorityName	Priority name
fMin	Min value
fMax	Max value
iType	Type, from DataMember: FLOAT, INTEGER, or BOOLEAN

◆ setPriority3()

void sortie.data.funcgroups.disturbance.HarvestData.setPriority3	(	String	sPriorityName,
		float	fMin,
		float	fMax,
		int	iType
	)

Sets priority 3 information.

Parameters

sPriorityName	Priority name
fMin	Min value
fMax	Max value
iType	Type, from DataMember: FLOAT, INTEGER, or BOOLEAN

◆ setSeedlingMortRate()

void sortie.data.funcgroups.disturbance.HarvestData.setSeedlingMortRate	(	int	iSpecies,
		float	fRate
	)

Sets the seedling mortality rate for a species.

Value should be between 0 and 100.

Parameters

iSpecies	Species to set.
fRate	Mortality rate.

◆ setTallestFirstFlag()

void sortie.data.funcgroups.disturbance.HarvestData.setTallestFirstFlag ( boolean bFlag )

Sets the flag for whether to cut tallest-to-smallest (true) or smallest- to-tallest (false).

Parameters

bFlag Tallest-to-smallest flag.

◆ setTimestep()

void sortie.data.funcgroups.disturbance.HarvestData.setTimestep ( int iTimestep ) throws ModelException

Sets the timestep for this cut event.

Parameters

iTimestep The timestep to set.

Exceptions

ModelException if the timestep is less than 0.

◆ setXCellLength()

void sortie.data.funcgroups.disturbance.HarvestData.setXCellLength ( float fXCellLength )

Sets the length of the cells in the X direction that define the area of this event.

Parameters

fXCellLength Length of the cells.

◆ setYCellLength()

void sortie.data.funcgroups.disturbance.HarvestData.setYCellLength ( float fYCellLength )

Sets the length of the cells in the Y direction that define the area of this event.

Parameters

fYCellLength Length of the cells.

◆ updateCellsNewGridResolution()

void sortie.data.funcgroups.disturbance.HarvestData.updateCellsNewGridResolution	(	float	fNewXCellLength,
		float	fNewYCellLength,
		Plot	oPlot
	)		throws ModelException

Adjusts any existing cell lists in response to grid cell changes.

Parameters

fNewXCellLength	New X cell length.
fNewYCellLength	New Y cell length.
oPlot	Plot object.

Exceptions

ModelException shouldn't.

◆ validateCut()

void sortie.data.funcgroups.disturbance.HarvestData.validateCut	(	TreePopulation	oPop,
		Plot	oPlot
	)		throws ModelException

Validates the current set of data in this cut.

This makes sure the following are all true:

there is at least one species
all species are valid
a timestep has been specified
a cut type has been specified
a cut amount type have been specified
there is at least one grid cell to which to apply the cut
there is at least one cut range to which to apply the cut
All values for seedling mortality are between 0 and 100

Parameters

oPop	TreePopulation object, to help verify data
oPlot	Plot object for timestep verification

Exceptions

ModelException if any of the above conditions is not true

◆ writePriority1XML()

void sortie.data.funcgroups.disturbance.HarvestData.writePriority1XML ( BufferedWriter jOut ) throws IOException

Writes XML for the first priority.

Parameters

jOut	File to write to.

Exceptions

IOException

◆ writePriority2XML()

void sortie.data.funcgroups.disturbance.HarvestData.writePriority2XML ( BufferedWriter jOut ) throws IOException

Writes XML for the second priority.

Parameters

jOut	File to write to.

Exceptions

IOException

◆ writePriority3XML()

void sortie.data.funcgroups.disturbance.HarvestData.writePriority3XML ( BufferedWriter jOut ) throws IOException

Writes XML for the third priority.

Parameters

jOut	File to write to.

Exceptions

IOException

Member Data Documentation

◆ ABSOLUTE_BASAL_AREA

final int sortie.data.funcgroups.disturbance.HarvestData.ABSOLUTE_BASAL_AREA = 3

static

Absolute basal area.

Matches the old code's enum value - that's important!

◆ ABSOLUTE_DENSITY

final int sortie.data.funcgroups.disturbance.HarvestData.ABSOLUTE_DENSITY = 1

static

Absolute density.

Matches the old code's enum value - that's important!

◆ CLEAR_CUT

final int sortie.data.funcgroups.disturbance.HarvestData.CLEAR_CUT = 3

static

Clear cut.

Matches the old code's enum value - that's important!.

◆ GAP_CUT

final int sortie.data.funcgroups.disturbance.HarvestData.GAP_CUT = 2

static

Gap cut.

Matches the old code's enum value - that's important!.

◆ m_bTallestFirst

boolean sortie.data.funcgroups.disturbance.HarvestData.m_bTallestFirst = true

private

Flag for whether to cut tallest-to-smallest (true) or smallest-to-tallest (false.

◆ m_fXCellLength

float sortie.data.funcgroups.disturbance.HarvestData.m_fXCellLength

private

Length of cells in the X direction.

◆ m_fYCellLength

float sortie.data.funcgroups.disturbance.HarvestData.m_fYCellLength

private

Length of cells in the Y direction.

◆ m_iCutAmountType

int sortie.data.funcgroups.disturbance.HarvestData.m_iCutAmountType = -1

private

How the cut amount is specified - possible values come from DisturbanceBehaviors and are PERCENTAGE_BASAL_AREA, ABSOLUTE_BASAL_AREA, PERCENTAGE_DENSITY, and ABSOLUTE_DENSITY.

◆ m_iCutType

int sortie.data.funcgroups.disturbance.HarvestData.m_iCutType = -1

private

The cut type - possible values come from DisturbanceBehaviors and are PARTIAL_CUT, GAP_CUT, and CLEAR_CUT.

◆ m_iTimestep

int sortie.data.funcgroups.disturbance.HarvestData.m_iTimestep = -1

private

Timestep to which to apply this harvest cut.

◆ m_oPriority1

CutPriority sortie.data.funcgroups.disturbance.HarvestData.m_oPriority1 = new CutPriority()

private

First cut priority.

◆ m_oPriority2

CutPriority sortie.data.funcgroups.disturbance.HarvestData.m_oPriority2 = new CutPriority()

private

Second cut priority.

◆ m_oPriority3

CutPriority sortie.data.funcgroups.disturbance.HarvestData.m_oPriority3 = new CutPriority()

private

Third cut priority.

◆ mp_fSeedlingMortRate

ArrayList<Float> sortie.data.funcgroups.disturbance.HarvestData.mp_fSeedlingMortRate = new ArrayList<Float>(0)

private

Seedling mortality rate.

◆ mp_iSpecies

ArrayList<Integer> sortie.data.funcgroups.disturbance.HarvestData.mp_iSpecies = new ArrayList<Integer>(0)

private

Species codes to which to apply this harvest cut.

◆ mp_oCells

ArrayList<Cell> sortie.data.funcgroups.disturbance.HarvestData.mp_oCells = new ArrayList<Cell>(0)

private

The list of cells to which to apply this cut (vector of Cell objects)

◆ mp_oCutRanges

ArrayList<CutRange> sortie.data.funcgroups.disturbance.HarvestData.mp_oCutRanges = new ArrayList<CutRange>(0)

private

The list of cut ranges and cut amounts (CutRange objects)

◆ NUMBER_ALLOWED_CUT_RANGES

int sortie.data.funcgroups.disturbance.HarvestData.NUMBER_ALLOWED_CUT_RANGES = 4

static

Maximum number of allowed cut ranges.

◆ PARTIAL_CUT

final int sortie.data.funcgroups.disturbance.HarvestData.PARTIAL_CUT = 1

static

Partial cut.

Matches the old code's enum value - that's important!.

◆ PERCENTAGE_BASAL_AREA

final int sortie.data.funcgroups.disturbance.HarvestData.PERCENTAGE_BASAL_AREA = 2

static

Percentage basal area.

Matches the old code's enum value - that's important!

◆ PERCENTAGE_DENSITY

final int sortie.data.funcgroups.disturbance.HarvestData.PERCENTAGE_DENSITY = 0

static

Percentage density.

Matches the old code's enum value - that's important!

The documentation for this class was generated from the following file:

HarvestData.java

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ HarvestData()

Member Function Documentation

◆ addCell() [1/2]

◆ addCell() [2/2]

◆ addCutRange()

◆ addSpecies()

◆ clearSpecies()

◆ clone()

◆ getCell()

◆ getCutAmount()

◆ getCutAmountType()

◆ getCutType()

◆ getLowerBound()

◆ getNumberOfCells()

◆ getNumberOfCutRanges()

◆ getNumberOfSpecies()

◆ getPriority1Max()

◆ getPriority1Min()

◆ getPriority1Name()

◆ getPriority1Type()

◆ getPriority2Max()

◆ getPriority2Min()

◆ getPriority2Name()

◆ getPriority2Type()

◆ getPriority3Max()

◆ getPriority3Min()

◆ getPriority3Name()

◆ getPriority3Type()

◆ getSeedlingMortRate()

◆ getSeedlingMortRateSize()

◆ getSpecies()

◆ getTallestFirstFlag()

◆ getTimestep()

◆ getUpperBound()

◆ getXCellLength()

◆ getYCellLength()

◆ removeAllCells()

◆ removeCell()

◆ removeSpecies()

◆ setCutAmountType()

◆ setCutType()

◆ setPriority1()

◆ setPriority2()

◆ setPriority3()

◆ setSeedlingMortRate()

◆ setTallestFirstFlag()

◆ setTimestep()

◆ setXCellLength()

◆ setYCellLength()

◆ updateCellsNewGridResolution()

◆ validateCut()

◆ writePriority1XML()

◆ writePriority2XML()

◆ writePriority3XML()

Member Data Documentation

◆ ABSOLUTE_BASAL_AREA

◆ ABSOLUTE_DENSITY

◆ CLEAR_CUT

◆ GAP_CUT

◆ m_bTallestFirst

◆ m_fXCellLength

◆ m_fYCellLength

◆ m_iCutAmountType

◆ m_iCutType

◆ m_iTimestep

◆ m_oPriority1

◆ m_oPriority2

◆ m_oPriority3

◆ mp_fSeedlingMortRate

◆ mp_iSpecies

◆ mp_oCells

◆ mp_oCutRanges

◆ NUMBER_ALLOWED_CUT_RANGES

◆ PARTIAL_CUT

◆ PERCENTAGE_BASAL_AREA