ucar.nc2.dt.trajectory
Class SingleTrajectoryObsDataset

java.lang.Object
  extended by ucar.nc2.dt.TypedDatasetImpl
      extended by ucar.nc2.dt.trajectory.SingleTrajectoryObsDataset
All Implemented Interfaces:
TrajectoryObsDataset, TypedDataset
Direct Known Subclasses:
ARMTrajectoryObsDataset, RafTrajectoryObsDataset, SimpleTrajectoryObsDataset, UnidataTrajectoryObsDataset, ZebraClassTrajectoryObsDataset

Deprecated. use ucar.nc2.ft.*

public class SingleTrajectoryObsDataset
extends TypedDatasetImpl
implements TrajectoryObsDataset

Superclass for for implementations of TrajectoryObsDataset using a NetcdfFile underneath that contains a single trajectory. The file must have a single coordinate variable for time. The time dimension may be UNLIMITED (if time is not UNLIMITED, there must be no UNLIMITED dimension). The file must also have a latitude variable, a longitude variable, and an elevation variable each on the time dimension only. The data variables also must be on the time dimension but they can also have other dimensions. For instance:

 time( time)  - convertable to -> double
 lat( time)   - convertable to -> double
 lon( time)   - convertable to -> double
 elev( time)  - convertable to -> double
 var1( time[, dim#]*)
 ...
 varN( time[, dim#]*)
 

Since:
5 May 2005 10:12 -0600
Author:
edavis

Nested Class Summary
static class SingleTrajectoryObsDataset.Config
          Deprecated.  
 
Field Summary
protected  Variable elevVar
          Deprecated.  
protected  double elevVarUnitsConversionFactor
          Deprecated.  
protected  Variable latVar
          Deprecated.  
protected  Variable lonVar
          Deprecated.  
protected  Structure recordVar
          Deprecated.  
protected  Dimension timeDim
          Deprecated.  
protected  Variable timeVar
          Deprecated.  
protected  String timeVarUnitsString
          Deprecated.  
protected  TrajectoryObsDatatype trajectory
          Deprecated.  
protected  String trajectoryId
          Deprecated.  
protected  int trajectoryNumPoint
          Deprecated.  
protected  HashMap trajectoryVarsMap
          Deprecated.  
 
Fields inherited from class ucar.nc2.dt.TypedDatasetImpl
boundingBox, dataVariables, desc, endDate, location, ncfile, parseInfo, startDate, title
 
Constructor Summary
SingleTrajectoryObsDataset()
          Deprecated.  
SingleTrajectoryObsDataset(NetcdfDataset ncfile)
          Deprecated.  
 
Method Summary
 String getDetailInfo()
          Deprecated.  
protected static double getMetersConversionFactor(String unitsString)
          Deprecated.  
 List getTrajectories()
          Deprecated. Get trajectories contained in this dataset.
 TrajectoryObsDatatype getTrajectory(String trajectoryId)
          Deprecated. Get the named trajectory
 List getTrajectoryIds()
          Deprecated. Get a list of String IDs for the available trajectories.
protected  void setBoundingBox()
          Deprecated.  
protected  void setEndDate()
          Deprecated.  
protected  void setStartDate()
          Deprecated.  
 void setTrajectoryInfo(SingleTrajectoryObsDataset.Config trajConfig)
          Deprecated. Setup needed for all SingleTrajectoryObsDatatypes.
 boolean syncExtend()
          Deprecated. Syncronize with the underlying dataset if it has been extended in a way that is compatible with the existing structural metadata (for instance, if the unlimited dimension has grown).
 
Methods inherited from class ucar.nc2.dt.TypedDatasetImpl
close, findGlobalAttributeIgnoreCase, getBoundingBox, getDataVariable, getDataVariables, getDescription, getEndDate, getGlobalAttributes, getLocation, getLocationURI, getNetcdfFile, getStartDate, getTitle, removeDataVariable, setDescription, setLocationURI, setTitle
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface ucar.nc2.dt.TypedDataset
close, findGlobalAttributeIgnoreCase, getBoundingBox, getDataVariable, getDataVariables, getDescription, getEndDate, getGlobalAttributes, getLocationURI, getNetcdfFile, getStartDate, getTitle
 

Field Detail

trajectoryId

protected String trajectoryId
Deprecated. 

trajectoryNumPoint

protected int trajectoryNumPoint
Deprecated. 

trajectoryVarsMap

protected HashMap trajectoryVarsMap
Deprecated. 

timeDim

protected Dimension timeDim
Deprecated. 

timeVar

protected Variable timeVar
Deprecated. 

recordVar

protected Structure recordVar
Deprecated. 

latVar

protected Variable latVar
Deprecated. 

lonVar

protected Variable lonVar
Deprecated. 

elevVar

protected Variable elevVar
Deprecated. 

timeVarUnitsString

protected String timeVarUnitsString
Deprecated. 

elevVarUnitsConversionFactor

protected double elevVarUnitsConversionFactor
Deprecated. 

trajectory

protected TrajectoryObsDatatype trajectory
Deprecated. 
Constructor Detail

SingleTrajectoryObsDataset

public SingleTrajectoryObsDataset()
Deprecated. 

SingleTrajectoryObsDataset

public SingleTrajectoryObsDataset(NetcdfDataset ncfile)
Deprecated. 
Method Detail

setTrajectoryInfo

public void setTrajectoryInfo(SingleTrajectoryObsDataset.Config trajConfig)
                       throws IOException
Deprecated. 
Setup needed for all SingleTrajectoryObsDatatypes. Can only be called once. Units of time varible must be udunits time units. Units of latitude variable must be convertible to "degrees_north" by udunits. Units of longitude variable must be convertible to "degrees_east" by udunits. Units of altitude variable must be convertible to "meters" by udunits.

Throws:
IllegalArgumentException - if units of time, latitude, longitude, or altitude variables are not as required.
IllegalStateException - if this method has already been called.
IOException

getMetersConversionFactor

protected static double getMetersConversionFactor(String unitsString)
                                           throws Exception
Deprecated. 
Throws:
Exception

setStartDate

protected void setStartDate()
Deprecated. 
Specified by:
setStartDate in class TypedDatasetImpl

setEndDate

protected void setEndDate()
Deprecated. 
Specified by:
setEndDate in class TypedDatasetImpl

setBoundingBox

protected void setBoundingBox()
Deprecated. 
Specified by:
setBoundingBox in class TypedDatasetImpl

getTrajectoryIds

public List getTrajectoryIds()
Deprecated. 
Description copied from interface: TrajectoryObsDataset
Get a list of String IDs for the available trajectories.

Specified by:
getTrajectoryIds in interface TrajectoryObsDataset
Returns:
list of ids for this dataset

getTrajectories

public List getTrajectories()
Deprecated. 
Description copied from interface: TrajectoryObsDataset
Get trajectories contained in this dataset.

Specified by:
getTrajectories in interface TrajectoryObsDataset
Returns:
List of type TrajectoryObsDatatype.

getTrajectory

public TrajectoryObsDatatype getTrajectory(String trajectoryId)
Deprecated. 
Description copied from interface: TrajectoryObsDataset
Get the named trajectory

Specified by:
getTrajectory in interface TrajectoryObsDataset
Parameters:
trajectoryId - id of trajectory
Returns:
the named trajectory

getDetailInfo

public String getDetailInfo()
Deprecated. 
Specified by:
getDetailInfo in interface TypedDataset
Overrides:
getDetailInfo in class TypedDatasetImpl
Returns:
debug / underlying implementation details

syncExtend

public boolean syncExtend()
Deprecated. 
Description copied from interface: TrajectoryObsDataset
Syncronize with the underlying dataset if it has been extended in a way that is compatible with the existing structural metadata (for instance, if the unlimited dimension has grown). Return true if syncronization was needed and sucessful. Otherwise, return false. NOTE: For now, assuming growth of the unlimited dimension only allowed change. To get range for new extent only, use getRange( oldNumPoints + 1, newNumPoints, 1)

Specified by:
syncExtend in interface TrajectoryObsDataset
Returns:
true if syncronization was needed and sucessful, otherwise false.


Copyright © 1999-2011 UCAR/Unidata. All Rights Reserved.