net.agmodel.weatherData
Interface Rain

All Superinterfaces:

CompoundSequence, MetSequence, Sequence

All Known Implementing Classes:

RainImpl

public interface Rain

extends MetSequence

Interface to a sequence of rainfall totals.

Method Summary

JigsawQuantity	getAverage(Interval interval) Returns the average rainfall over the interval.
JigsawQuantity	getMaximum(Interval interval) Returns the maximum rainfall over the interval.
JigsawQuantity	getMinimum(Interval interval) Returns the minimum rainfall over the interval.
JigsawQuantity	getTotal(Date time) Returns the rainfall over the period preceding or including the time specified.
JigsawQuantity	getTotal(Interval interval) Returns the total rainfall over the interval.

Methods inherited from interface net.agmodel.weatherData.MetSequence

getSequenceElement, summarize

Methods inherited from interface net.agmodel.physical.CompoundSequence

cancelTemporalInterpolation, getAllCoverage, getAllData, getCoverage, getData, getMaximumTemporalInterpolation, getSubHeading, getTemporalInterpolation, getUnitsHeading, setSequenceHeading, setSubHeading, setTemporalInterpolation, setUnitsHeading

Methods inherited from interface net.agmodel.physical.Sequence

clone, dumpSequence, getColumnHeading, getContentsAsString, getCurrentResolution, getDateRange, getName, getNumberOfSubComponents, getResolution, getSequenceHeading, getSubHeading, getSummaryKind, getUnitsHeading, setColumnHeading, setName

Method Detail

getMinimum

public JigsawQuantity getMinimum(Interval interval)

Returns the minimum rainfall over the interval. Rainfall readings at either end of the interval are included in the comparison if more than 50% of their duration lies within the interval of interest.

Returns:

the minimum rainfall

getMaximum

public JigsawQuantity getMaximum(Interval interval)

Returns the maximum rainfall over the interval. Rainfall readings at either end of the interval are included in the comparison if more than 50% of their duration lies within the interval of interest.

Returns:

the maximum rainfall

getAverage

public JigsawQuantity getAverage(Interval interval)

Returns the average rainfall over the interval. Rainfall readings at either end of the interval are included by weighting their values according to the proportion of their duration that lies in the period of interest.

Returns:

the average value

getTotal

public JigsawQuantity getTotal(Interval interval)

Returns the total rainfall over the interval. Rainfall readings at either end of the interval are included by weighting their values according to the proportion of their duration that lies in the period of interest.

Returns:

the total value

getTotal

public JigsawQuantity getTotal(Date time)

Returns the rainfall over the period preceding or including the time specified.

Returns:

the total value