net.agmodel.weatherData
Interface ScalarQuantity

All Superinterfaces:
CompoundSequence, MetSequence, Sequence
All Known Subinterfaces:
AirTemperature, Humidity, LeafWetness, WaterTemperature
All Known Implementing Classes:
AirTempMaxMinImpl, AirTempMaxMinMeanImpl, AirTempMultiImpl, AirTempSingleImpl, LeafWetnessMultiImpl, LeafWetnessSingleImpl, RHImpl, WaterTempSingleImpl, WetDryImpl

public interface ScalarQuantity
extends MetSequence

Parent interface for air and water temperature, and leaf wetness sequences.


Method Summary
 JigsawQuantity getAverage(Interval interval)
          Returns the average temperature over the interval.
 JigsawQuantity getInstant(Date time)
          Returns the instantaneous temperature at a particular point in time.
 JigsawQuantity getMaximum(Interval interval)
          Returns the maximum temperature over the interval.
 JigsawQuantity getMinimum(Interval interval)
          Returns the minimum temperature 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 temperature over the interval. Temperatures at either end of the interval are included in the comparison if more than 50% of their duration lies within the interval of interest.

Parameters:
interval - the interval of interest
Returns:
the minimum temperature

getMaximum

public JigsawQuantity getMaximum(Interval interval)
Returns the maximum temperature over the interval. Sequence values at either end of the interval are included in the comparison if more than 50% of their duration lies within the interval of interest.

Parameters:
interval - the interval of interest
Returns:
the maximum value

getInstant

public JigsawQuantity getInstant(Date time)
Returns the instantaneous temperature at a particular point in time. If interpolation is requested, the value may be spatially and/or temporally interpolated from other data.

Parameters:
time - the time of interest
Returns:
the instantaneous value

getAverage

public JigsawQuantity getAverage(Interval interval)
Returns the average temperature over the interval. Temperatures 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.

Parameters:
interval - the interval of interest
Returns:
the average value