ucar.nc2.dt

Interface RadialDatasetSweep

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, FeatureDataset, FileCacheable, TypedDataset

All Known Subinterfaces:

StationRadialDataset

All Known Implementing Classes:

CFnetCDF2Dataset, Dorade2Dataset, LevelII2Dataset, Netcdf2Dataset, Nids2Dataset, RadialDatasetSweepAdapter, UF2Dataset

public interface RadialDatasetSweep
extends TypedDataset, FeatureDataset

A RadialDataset in which the radials can be grouped into sweeps. A sweep has the same gate geometry for all radials in the sweep, and has a RadialDatasetSweep.Type.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RadialDatasetSweep.RadialVariable A data Variable with radial geometry.
static interface	RadialDatasetSweep.Sweep A sweep is 2D data using radial coordinate system (elevation, azimuth, radial distance)
static class	RadialDatasetSweep.Type A Type of RadialSweep.

Method Summary

Modifier and Type	Method and Description
void	clearDatasetMemory() Remove cached data, if any.
EarthLocation	getCommonOrigin() If all sweeps have the same origin, return it here, else null
RadialDatasetSweep.Type	getCommonType() If all the sweeps are the same type, return it here, else NONE
java.lang.String	getDataFormat()
java.util.List<VariableSimpleIF>	getDataVariables() The radial data variables available in the dataset.
java.lang.String	getRadarID()
java.lang.String	getRadarName()
DateUnit	getTimeUnits() Get the units of Calendar time.
boolean	isStationary() Stationary versus moving radar.
boolean	isVolume() Get the basic property of Radar,

Methods inherited from interface ucar.nc2.dt.TypedDataset

close, findGlobalAttributeIgnoreCase, getBoundingBox, getDataVariable, getDescription, getDetailInfo, getEndDate, getGlobalAttributes, getLocationURI, getNetcdfFile, getStartDate, getTitle

Methods inherited from interface ucar.nc2.ft.FeatureDataset

calcBounds, close, findGlobalAttributeIgnoreCase, getBoundingBox, getCalendarDateEnd, getCalendarDateRange, getCalendarDateStart, getDataVariable, getDateRange, getDescription, getDetailInfo, getEndDate, getFeatureType, getGlobalAttributes, getImplementationName, getLocation, getNetcdfFile, getStartDate, getTitle

Methods inherited from interface ucar.nc2.util.cache.FileCacheable

getLastModified, reacquire, release, setFileCache

Method Detail

getRadarID

java.lang.String getRadarID()

Returns:

radar id

getRadarName

java.lang.String getRadarName()

Returns:

radar name

getDataFormat

java.lang.String getDataFormat()

Returns:

data format

getCommonType

RadialDatasetSweep.Type getCommonType()

If all the sweeps are the same type, return it here, else NONE

Returns:

type of sweep, or NONE

getCommonOrigin

EarthLocation getCommonOrigin()

If all sweeps have the same origin, return it here, else null

Returns:

common origin, or null

getTimeUnits

DateUnit getTimeUnits()

Get the units of Calendar time. To get a Date, from a time value, call DateUnit.getStandardDate(double value). To get units as a String, call DateUnit.getUnitsString().

Returns:

units of Calendar time

isStationary

boolean isStationary()

Stationary versus moving radar.

Returns:

true if this is stationary.

clearDatasetMemory

void clearDatasetMemory()

Remove cached data, if any.

isVolume

boolean isVolume()

Get the basic property of Radar,

Returns:

0 if there is only one sweep

getDataVariables

java.util.List<VariableSimpleIF> getDataVariables()

The radial data variables available in the dataset.

Specified by:

getDataVariables in interface FeatureDataset

Specified by:

getDataVariables in interface TypedDataset

Returns:

List of type RadialDatasetSweep.RadialVariable