ucar.nc2.dt.fmrc

Interface ForecastModelRunCollection

All Known Implementing Classes:

FmrcImpl

public interface ForecastModelRunCollection

Forecast Model Run Collection

Author:

caron

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
NetcdfDataset	getBestTimeSeries() Get a NetcdfDataset that has the "best" time series, across model runs.
NetcdfDataset	getFmrcDataset() Get a NetcdfDataset that is the underlying datasets with the "2d time"
java.util.List<java.util.Date>	getForecastDates() Get the list of possible forecast dates, to be used in getForecastTimeDataset().
NetcdfDataset	getForecastOffsetDataset(double hours) Get a NetcdfDataset that has all the data for a fixed forecast offset, across model runs.
java.util.List<java.lang.Double>	getForecastOffsets() Get the list of possible forecast offsets, to be used in getForecastOffsetDataset().
NetcdfDataset	getForecastTimeDataset(java.util.Date forecastTime) Get a NetcdfDataset that has all the data for a fixed forecast time, across model runs.
GridDataset	getGridDataset() Get the underlying GridDataset.
java.util.List<java.util.Date>	getRunDates() Get the list of possible run dates, to be used in getRunTimeDataset().
NetcdfDataset	getRunTimeDataset(java.util.Date runTime) Get a NetcdfDataset that has all the data for a model run.
boolean	sync() Check if file has changed, and reread metadata if needed.

Method Detail

getRunDates

java.util.List<java.util.Date> getRunDates()

Get the list of possible run dates, to be used in getRunTimeDataset().

Returns:

List of Date

getRunTimeDataset

NetcdfDataset getRunTimeDataset(java.util.Date runTime)
                                throws java.io.IOException

Get a NetcdfDataset that has all the data for a model run. The time coordinate will be the forecast time. The runtime will be a global attribute called "_runTime" containing an ISO date string.

Parameters:

runTime - names the run

Returns:

the NetcdfDataset for that data.

Throws:

java.io.IOException - on read error

getForecastDates

java.util.List<java.util.Date> getForecastDates()

Get the list of possible forecast dates, to be used in getForecastTimeDataset().

Returns:

List of Date

getForecastTimeDataset

NetcdfDataset getForecastTimeDataset(java.util.Date forecastTime)
                                     throws java.io.IOException

Get a NetcdfDataset that has all the data for a fixed forecast time, across model runs. The time coordinate will be the run time. The forecast time will be a global attribute called "_forecastTime" containing an ISO date string.

Parameters:

forecastTime - the forecast time to fix.

Returns:

the NetcdfDataset for that data.

Throws:

java.io.IOException - on read error

getForecastOffsets

java.util.List<java.lang.Double> getForecastOffsets()

Get the list of possible forecast offsets, to be used in getForecastOffsetDataset().

Returns:

List of Double

getForecastOffsetDataset

NetcdfDataset getForecastOffsetDataset(double hours)
                                       throws java.io.IOException

Get a NetcdfDataset that has all the data for a fixed forecast offset, across model runs. The time coordinate will be the forecast time. There will be a String-valued variable called "RunTime(time)" containing an array of ISO date strings.

Parameters:

hours - the forecast offset time to fix, in hours.

Returns:

the NetcdfDataset containing that data.

Throws:

java.io.IOException - on read error

getBestTimeSeries

NetcdfDataset getBestTimeSeries()
                                throws java.io.IOException

Get a NetcdfDataset that has the "best" time series, across model runs. The time coordinate will be the forecast time. There will be a String-valued variable called "RunTime(time)" containing an array of ISO date strings.

Returns:

the NetcdfDataset containing that data.

Throws:

java.io.IOException - on read error

getFmrcDataset

NetcdfDataset getFmrcDataset()

Get a NetcdfDataset that is the underlying datasets with the "2d time"

Returns:

the NetcdfDataset containing that data.

getGridDataset

GridDataset getGridDataset()

Get the underlying GridDataset.

Returns:

the GridDataset containing that data.

sync

boolean sync()
             throws java.io.IOException

Check if file has changed, and reread metadata if needed.

Returns:

true if file was changed.

Throws:

java.io.IOException - on io error

close

void close()
           throws java.io.IOException

Throws:

java.io.IOException