repicea.simulation.disturbances

Class DisturbanceOccurrences

java.lang.Object

repicea.simulation.disturbances.DisturbanceOccurrences

public class DisturbanceOccurrences
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DisturbanceOccurrences(DisturbanceAffectedProvider parms) Basic constructor
DisturbanceOccurrences(DisturbanceAffectedProvider parms, int dateYr) Constructor for single occurrences
DisturbanceOccurrences(DisturbanceAffectedProvider parms, java.util.List<java.lang.Integer> datesYr) Constructor for multiple occurrences

Method Summary

Modifier and Type	Method and Description
void	addOccurrenceDateYr(int dateYr)
int	getLastOccurrenceDateYrToDate(int currentDateYr) Returns the date of the latest occurrence
int	getNumberOfOccurrences() Return the number of occurrences.
boolean	isThereAnyOccurrence() Returns true if there is at least one occurrence.
boolean	isThisPlotAffected(MonteCarloSimulationCompliantObject plot) This method checks whether a particular plot is affected by the disturbance.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DisturbanceOccurrences

public DisturbanceOccurrences(DisturbanceAffectedProvider parms,
                              java.util.List<java.lang.Integer> datesYr)

Constructor for multiple occurrences

Parameters:

parms -

datesYr - a List of dates (integers)

DisturbanceOccurrences

public DisturbanceOccurrences(DisturbanceAffectedProvider parms)

Basic constructor

Parameters:

parms -

DisturbanceOccurrences

public DisturbanceOccurrences(DisturbanceAffectedProvider parms,
                              int dateYr)

Constructor for single occurrences

Parameters:

parms -

dateYr -

Method Detail

isThisPlotAffected

public boolean isThisPlotAffected(MonteCarloSimulationCompliantObject plot)

This method checks whether a particular plot is affected by the disturbance. It assumes that the method isThereADisturbance of the DisturbanceParameters class has returned true.

Parameters:

plot - a MonteCarloSimulationCompliantObject instance

Returns:

a boolean

addOccurrenceDateYr

public void addOccurrenceDateYr(int dateYr)

getLastOccurrenceDateYrToDate

public int getLastOccurrenceDateYrToDate(int currentDateYr)

Returns the date of the latest occurrence

Parameters:

currentDateYr - the reference date

Returns:

an integer

isThereAnyOccurrence

public boolean isThereAnyOccurrence()

Returns true if there is at least one occurrence.

Returns:

a boolean

getNumberOfOccurrences

public int getNumberOfOccurrences()

Return the number of occurrences.

Returns:

an integer