repicea.simulation.covariateproviders.plotlevel

Interface NaturalDisturbanceInformationProvider

public interface NaturalDisturbanceInformationProvider

This interface ensures the instance can provide either the time since the last disturbance or at least the time since the first known date.

Method Summary

Modifier and Type	Method and Description
int	getTimeSinceFirstKnownDateYrs(int currentDateYrs) This method returns the time since the first known date.
java.lang.Integer	getTimeSinceLastDisturbanceYrs(DisturbanceTypeProvider.DisturbanceType type, int currentDateYrs) This method returns the time since the last disturbance or null if this time is unknown.

Method Detail

getTimeSinceLastDisturbanceYrs

java.lang.Integer getTimeSinceLastDisturbanceYrs(DisturbanceTypeProvider.DisturbanceType type,
                                                 int currentDateYrs)

This method returns the time since the last disturbance or null if this time is unknown.

Parameters:

currentDateYrs - the current date

Returns:

an Integer instance or null

getTimeSinceFirstKnownDateYrs

int getTimeSinceFirstKnownDateYrs(int currentDateYrs)

This method returns the time since the first known date. This is a work-around if the getTimeSinceLastDisturbanceYrs method returns null.

Parameters:

currentDateYrs - the current date

Returns:

a positive integer