net.agmodel.weatherData
Interface Sunshine

All Superinterfaces:

CompoundSequence, MetSequence, Sequence

All Known Implementing Classes:

SunshineImpl

public interface Sunshine

extends MetSequence

Interface to a sequence of sunshine records (hours of bright sunlight).

Method Summary

JigsawQuantity	getAverage(Interval interval) Returns the average hours of sunshine over the interval.
JigsawQuantity	getMaximum(Interval interval) Returns the maximum sunshine hours over the interval.
JigsawQuantity	getMinimum(Interval interval) Returns the minimum hours of sunlight over the interval.
JigsawQuantity	getTotal(Date time) Returns the sunshine over the period preceding and including the time specified.
JigsawQuantity	getTotal(Interval interval) Returns the total sunshine hours 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 hours of sunlight over the interval. Sunshine 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 hours of sunshine

getMaximum

public JigsawQuantity getMaximum(Interval interval)

Returns the maximum sunshine hours over the interval. Sunshine 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 sunshine

getAverage

public JigsawQuantity getAverage(Interval interval)

Returns the average hours of sunshine over the interval. Sunshine 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 sunshine hours over the interval. Sunshine 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 sunshine over the period preceding and including the time specified.

Returns:

the total value