net.agmodel.weatherData
Interface MetSequence

All Superinterfaces:

CompoundSequence, Sequence

All Known Subinterfaces:

AirTemperature, Humidity, LeafWetness, MultiQuantity, Rain, ScalarQuantity, SoilTemperature, SolarRadiation, Sunshine, WaterTemperature, Wind

All Known Implementing Classes:

AirTempMaxMinImpl, AirTempMaxMinMeanImpl, AirTempMultiImpl, AirTempSingleImpl, GeneralMetSequenceImpl, LeafWetnessMultiImpl, LeafWetnessSingleImpl, MultiImpl, RainImpl, RHImpl, SoilTemperatureImpl, SolarRadiationImpl, SunshineImpl, WaterTempSingleImpl, WetDryImpl, WindImpl, WindProfileImpl

public interface MetSequence

extends CompoundSequence

Interface to sequences of measurements of an element from a station.
MetSequence is an parent for element-specific descendents.
These descendents are primarily used to pass data back from MetBroker to client applications.
In some situations a decendent may contain several related time series of data (eg wet and dry bulb temperatures).
Descendants "uncover" the relevant protected methods of Sequence as required.
This avoids nonsense functions like Temperature.getTotal() or Rain.getInstant().
or ambiguity in situations like AirTempMaxMin.getInstant().
Data is stored in one or more Store utility classes.
This separation is so different storage methods can be "plugged in" for different kinds of data
eg. rainfall data or leaf wetness data can readily be compressed by a kind of run length encoding. Hourly temperatures are less amenable to such compression.

Note that Sequences follow the same convention as MetRequests, which is that the range of data stored is partially closed (start,end].
This means in descendent classes you can call getInstantValue(end) but not getInstantValue(start).
This differs from Store, where you can call getInstant

Author:

Matthew Laurenson

Method Summary

MetElement	getSequenceElement() Returns the meteorological element stored in the sequence.
MetSequence	summarize(Duration longerResolution) Creates a lower resolution sequence which summarizes this sequence

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

getSequenceElement

public MetElement getSequenceElement()

Returns the meteorological element stored in the sequence.

Returns:

the meteorological element

summarize

public MetSequence summarize(Duration longerResolution)

Creates a lower resolution sequence which summarizes this sequence

Parameters:

longerResolution - the new resolution to summarize to

Returns:

a summarized sequence.