Package ucar.nc2.ft.point

Class RecordDatasetHelper

java.lang.Object

ucar.nc2.ft.point.RecordDatasetHelper

public class RecordDatasetHelper
extends Object

Helper class for using the netcdf-3 record dimension.

Since:

Feb 29, 2008

Field Summary

Fields

Modifier and Type	Field	Description
protected double	altScaleFactor
protected ucar.unidata.geoloc.LatLonRect	boundingBox
protected Formatter	errs
protected String	latVName
protected String	lonVName
protected double	maxDate
protected double	minDate
protected ucar.nc2.dataset.NetcdfDataset	ncfile
protected String	nomTimeVName
protected ucar.nc2.Dimension	obsDim
protected String	obsTimeVName
protected ucar.nc2.dataset.StructureDS	recordVar
protected ucar.nc2.ft.point.StationHelper	stationHelper
protected ucar.ma2.DataType	stationIdType
protected String	stnDescVName
protected String	stnIdVName
protected String	stnIndexVName
protected ucar.nc2.time.CalendarDateUnit	timeUnit
protected String	zcoordUnits
protected String	zcoordVName

Constructor Summary

Constructors

Constructor	Description
RecordDatasetHelper(ucar.nc2.dataset.NetcdfDataset ncfile, String obsTimeVName, String nomTimeVName, List<ucar.nc2.VariableSimpleIF> typedDataVariables, String recDimName, Formatter errBuffer)	Constructor.

Method Summary

Modifier and Type	Method	Description
ucar.nc2.ft.PointFeature	factory(ucar.unidata.geoloc.StationImpl s, ucar.ma2.StructureData sdata, int recno)
double	getLatitude(ucar.ma2.StructureData sdata)
ucar.unidata.geoloc.LatLonPoint	getLocation(ucar.ma2.StructureData sdata)
double	getLongitude(ucar.ma2.StructureData sdata)
protected static double	getMetersConversionFactor(String unitsString)
double	getObservationTime(ucar.ma2.StructureData sdata)
ucar.nc2.time.CalendarDate	getObservationTimeAsDate(ucar.ma2.StructureData sdata)
int	getRecordCount()
ucar.nc2.Structure	getRecordVar()
ucar.nc2.time.CalendarDateUnit	getTimeUnit()
double	getZcoordinate(ucar.ma2.StructureData sdata)
String	getZcoordUnits()
void	setLocationInfo(String latVName, String lonVName, String zcoordVName)
void	setShortNames(String latVName, String lonVName, String altVName, String obsTimeVName, String nomTimeVName)
void	setStationInfo(String stnIdVName, String stnDescVName, String stnIndexVName, ucar.nc2.ft.point.StationHelper stationHelper)	Set extra information used by station obs datasets.
void	setTimeUnit(ucar.nc2.time.CalendarDateUnit timeUnit)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ncfile

protected ucar.nc2.dataset.NetcdfDataset ncfile

obsTimeVName

protected String obsTimeVName

nomTimeVName

protected String nomTimeVName

latVName

protected String latVName

lonVName

protected String lonVName

zcoordVName

protected String zcoordVName

zcoordUnits

protected String zcoordUnits

stnIdVName

protected String stnIdVName

stnIndexVName

protected String stnIndexVName

stnDescVName

protected String stnDescVName

stationHelper

protected ucar.nc2.ft.point.StationHelper stationHelper

stationIdType

protected ucar.ma2.DataType stationIdType

recordVar

protected ucar.nc2.dataset.StructureDS recordVar

obsDim

protected ucar.nc2.Dimension obsDim

boundingBox

protected ucar.unidata.geoloc.LatLonRect boundingBox

minDate

protected double minDate

maxDate

protected double maxDate

timeUnit

protected ucar.nc2.time.CalendarDateUnit timeUnit

altScaleFactor

protected double altScaleFactor

errs

protected Formatter errs

Constructor Detail

RecordDatasetHelper

public RecordDatasetHelper(ucar.nc2.dataset.NetcdfDataset ncfile,
                           String obsTimeVName,
                           String nomTimeVName,
                           List<ucar.nc2.VariableSimpleIF> typedDataVariables,
                           String recDimName,
                           Formatter errBuffer)

Constructor.

Parameters:

ncfile - the netccdf file

typedDataVariables - list of data variables; all record variables will be added to this list, except . You can remove extra

obsTimeVName - observation time variable name (required)

nomTimeVName - nominal time variable name (may be null)

Throws:

IllegalArgumentException - if ncfile has no unlimited dimension and recDimName is null.

Method Detail

setStationInfo

public void setStationInfo(String stnIdVName,
                           String stnDescVName,
                           String stnIndexVName,
                           ucar.nc2.ft.point.StationHelper stationHelper)

Set extra information used by station obs datasets. Use stnIdVName or stnIndexVName.

Parameters:

stnIdVName - the obs variable that is used to find the station in the stnHash; may be type int or a String (char).

stnDescVName - optional station var containing station description

setLocationInfo

public void setLocationInfo(String latVName,
                            String lonVName,
                            String zcoordVName)

setShortNames

public void setShortNames(String latVName,
                          String lonVName,
                          String altVName,
                          String obsTimeVName,
                          String nomTimeVName)

getMetersConversionFactor

protected static double getMetersConversionFactor(String unitsString)
                                           throws Exception

Throws:

Exception

getRecordVar

public ucar.nc2.Structure getRecordVar()

getRecordCount

public int getRecordCount()

setTimeUnit

public void setTimeUnit(ucar.nc2.time.CalendarDateUnit timeUnit)

getTimeUnit

public ucar.nc2.time.CalendarDateUnit getTimeUnit()

getLocation

public ucar.unidata.geoloc.LatLonPoint getLocation(ucar.ma2.StructureData sdata)

getLatitude

public double getLatitude(ucar.ma2.StructureData sdata)

getLongitude

public double getLongitude(ucar.ma2.StructureData sdata)

getZcoordinate

public double getZcoordinate(ucar.ma2.StructureData sdata)

getZcoordUnits

public String getZcoordUnits()

getObservationTimeAsDate

public ucar.nc2.time.CalendarDate getObservationTimeAsDate(ucar.ma2.StructureData sdata)

getObservationTime

public double getObservationTime(ucar.ma2.StructureData sdata)

factory

public ucar.nc2.ft.PointFeature factory(ucar.unidata.geoloc.StationImpl s,
                                        ucar.ma2.StructureData sdata,
                                        int recno)