repicea.simulation.climate

Class REpiceaClimateChangeTrend

java.lang.Object

java.util.AbstractCollection<E>

java.util.AbstractList<E>

java.util.ArrayList<repicea.simulation.climate.REpiceaClimateChangeTrendSegment>

repicea.simulation.climate.REpiceaClimateChangeTrend

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.lang.Iterable<repicea.simulation.climate.REpiceaClimateChangeTrendSegment>, java.util.Collection<repicea.simulation.climate.REpiceaClimateChangeTrendSegment>, java.util.List<repicea.simulation.climate.REpiceaClimateChangeTrendSegment>, java.util.RandomAccess

public class REpiceaClimateChangeTrend
extends java.util.ArrayList<repicea.simulation.climate.REpiceaClimateChangeTrendSegment>

See Also:

Serialized Form

Field Summary

Fields inherited from class java.util.AbstractList

modCount

Constructor Summary

Constructors

Constructor and Description
REpiceaClimateChangeTrend()

Method Summary

Modifier and Type	Method and Description
void	addSegment(int startDateYr, int endDateYr, REpiceaClimateVariableChangeMap changeMap)
double	getAverageChangeOverThisPeriod(int referenceDateYr, int startDateYr, int endDateYr, REpiceaClimateVariableMap.ClimateVariable variable) Return the average change over a particular time interval with respect to a reference date.
double	getChangeFromTo(int startDateYr, int endDateYr, REpiceaClimateVariableMap.ClimateVariable variable) Provides the change in the variable between the start and the end dates.
int	getEndDateYr() Returns the last end date of the trend.
int	getStartDateYr() Returns the start date of the trend.

Methods inherited from class java.util.ArrayList

add, add, addAll, addAll, clear, clone, contains, ensureCapacity, forEach, get, indexOf, isEmpty, iterator, lastIndexOf, listIterator, listIterator, remove, remove, removeAll, removeIf, removeRange, replaceAll, retainAll, set, size, sort, spliterator, subList, toArray, toArray, trimToSize

Methods inherited from class java.util.AbstractList

equals, hashCode

Methods inherited from class java.util.AbstractCollection

containsAll, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.List

containsAll, equals, hashCode

Methods inherited from interface java.util.Collection

parallelStream, stream

Constructor Detail

REpiceaClimateChangeTrend

public REpiceaClimateChangeTrend()

Method Detail

addSegment

public void addSegment(int startDateYr,
                       int endDateYr,
                       REpiceaClimateVariableChangeMap changeMap)

getEndDateYr

public int getEndDateYr()

Returns the last end date of the trend.

Returns:

an integer

getStartDateYr

public int getStartDateYr()

Returns the start date of the trend.

Returns:

an integer

getChangeFromTo

public double getChangeFromTo(int startDateYr,
                              int endDateYr,
                              REpiceaClimateVariableMap.ClimateVariable variable)

Provides the change in the variable between the start and the end dates.

Parameters:

startDateYr -

endDateYr -

variable - a ClimateVariable enum

Returns:

the change

getAverageChangeOverThisPeriod

public double getAverageChangeOverThisPeriod(int referenceDateYr,
                                             int startDateYr,
                                             int endDateYr,
                                             REpiceaClimateVariableMap.ClimateVariable variable)

Return the average change over a particular time interval with respect to a reference date.

Parameters:

referenceDateYr -

startDateYr -

endDateYr -

variable - a ClimateVariable enum

Returns:

the average change