ucar.nc2.dt

Interface TrajectoryObsDatatype

Deprecated.

use ucar.nc2.ft.*

public interface TrajectoryObsDatatype

A sequence (one-dimensional, variable-length list) of PointObsDatatype, connected in space and time. The observations are ordered in time (in other words, the time dimension must increase monotonically along the trajectory).

Method Summary

Modifier and Type	Method and Description
LatLonRect	getBoundingBox() Deprecated. BoundingBox for the trajectory.
StructureData	getData(int point) Deprecated. Get values for all parameters (except time, lat, lon, and elev) at the requested trajectory point.
Array	getData(int point, java.lang.String parameterName) Deprecated.
Array	getData(Range range, java.lang.String parameterName) Deprecated. Get the values of the requested parameter on the given Range of the trajectory.
DataIterator	getDataIterator(int bufferSize) Deprecated. Get an efficient iterator over all the data in the Trajectory in time order.
VariableSimpleIF	getDataVariable(java.lang.String name) Deprecated. Get the named data Variable.
java.util.List	getDataVariables() Deprecated. Return a list of the data Variables available in this dataset.
java.lang.String	getDescription() Deprecated. A description of the trajectory.
double	getElevation(int point) Deprecated. Return the elevation at the requested trajectory point in units of meters, missing values = NaN.
Array	getElevation(Range range) Deprecated. Get the elevation values on the given Range of the trajectory.
java.util.Date	getEndDate() Deprecated. End date for the trajectory.
Range	getFullRange() Deprecated. Get the range for the entire trajectory.
java.lang.String	getId() Deprecated. The ID of the trajectory, may not be null.
double	getLatitude(int point) Deprecated. Return the latitude at the requested trajectory point in units of "degrees_north".
Array	getLatitude(Range range) Deprecated. Get the latitude values on the given Range of the trajectory.
EarthLocation	getLocation(int point) Deprecated. Return the location for the given point.
double	getLongitude(int point) Deprecated. Return the longitude at the requested trajectory point in units of "degrees_east".
Array	getLongitude(Range range) Deprecated. Get the longitude values on the given Range of the trajectory.
int	getNumberPoints() Deprecated. The number of points along the trajectory.
PointObsDatatype	getPointObsData(int point) Deprecated. Get a PointObsDatatype for the requested trajectory point.
Range	getPointRange(int point) Deprecated. Get a range for a single point in the trajectory.
Range	getRange(int start, int end, int stride) Deprecated. Get a range with the given start, end, and stride in the trajectory.
java.util.Date	getStartDate() Deprecated. Start date for the trajectory.
java.util.Date	getTime(int point) Deprecated. Return the time for the given point as a java.util.Date.
Array	getTime(Range range) Deprecated. Get the time values on the given Range of the trajectory.
java.lang.String	getTimeUnitsIdentifier() Deprecated. Return the String representation of the units for time.
double	getTimeValue(int point) Deprecated. Return the time for the given point as a double in the units given by getTimeUnitsIdentifier().

Method Detail

getId

java.lang.String getId()

Deprecated.

The ID of the trajectory, may not be null.

getDescription

java.lang.String getDescription()

Deprecated.

A description of the trajectory.

getNumberPoints

int getNumberPoints()

Deprecated.

The number of points along the trajectory.

getDataVariables

java.util.List getDataVariables()

Deprecated.

Return a list of the data Variables available in this dataset. The list contains only "data variables of interest", not metadata or coordinate system variables, etc.

Returns:

List of type TypedDataVariable

getDataVariable

VariableSimpleIF getDataVariable(java.lang.String name)

Deprecated.

Get the named data Variable.

Parameters:

name - of data Variable.

Returns:

TypedDataVariable or null.

getPointObsData

PointObsDatatype getPointObsData(int point)
                          throws java.io.IOException

Deprecated.

Get a PointObsDatatype for the requested trajectory point.

Parameters:

point - the point along the trajectory

Returns:

corresponding PointObsDatatype

Throws:

java.io.IOException

getStartDate

java.util.Date getStartDate()

Deprecated.

Start date for the trajectory.

getEndDate

java.util.Date getEndDate()

Deprecated.

End date for the trajectory.

getBoundingBox

LatLonRect getBoundingBox()

Deprecated.

BoundingBox for the trajectory. May not be available.

getTime

java.util.Date getTime(int point)
                throws java.io.IOException

Deprecated.

Return the time for the given point as a java.util.Date.

Throws:

java.io.IOException

getLocation

EarthLocation getLocation(int point)
                   throws java.io.IOException

Deprecated.

Return the location for the given point.

Throws:

java.io.IOException

getTimeValue

double getTimeValue(int point)
             throws java.io.IOException

Deprecated.

Return the time for the given point as a double in the units given by getTimeUnitsIdentifier().

Throws:

java.io.IOException

getTimeUnitsIdentifier

java.lang.String getTimeUnitsIdentifier()

Deprecated.

Return the String representation of the units for time.

getLatitude

double getLatitude(int point)
            throws java.io.IOException

Deprecated.

Return the latitude at the requested trajectory point in units of "degrees_north".

Throws:

java.io.IOException

getLongitude

double getLongitude(int point)
             throws java.io.IOException

Deprecated.

Return the longitude at the requested trajectory point in units of "degrees_east".

Throws:

java.io.IOException

getElevation

double getElevation(int point)
             throws java.io.IOException

Deprecated.

Return the elevation at the requested trajectory point in units of meters, missing values = NaN.

Throws:

java.io.IOException

getData

StructureData getData(int point)
               throws java.io.IOException,
                      InvalidRangeException

Deprecated.

Get values for all parameters (except time, lat, lon, and elev) at the requested trajectory point. Units are as given by getXXUnitsIdentifier() methods.

Parameters:

point - the index point into the trajectory

Returns:

ucar.nc2.StructureData containing an Array for each parameter.

Throws:

java.io.IOException - if problems reading data.

InvalidRangeException

getData

Array getData(int point,
              java.lang.String parameterName)
       throws java.io.IOException

Deprecated.

Throws:

java.io.IOException

getDataIterator

DataIterator getDataIterator(int bufferSize)
                      throws java.io.IOException

Deprecated.

Get an efficient iterator over all the data in the Trajectory in time order. This is an optional method; it will return null if no iterator is available. This is the efficient way to get all the data, it can be 100 times faster than getData(). This will return an iterator over type getDataClass(), and the actual data has already been read into memory, that is, dataType.getData() will not incur any I/O.

This is accomplished by buffering bufferSize amount of data at once. You must fully process the data, or copy it out of the StructureData, as you iterate over it, in order for the garbage collector to work.

We dont need a cancelTask, just stop the iteration if the user want to cancel.

Parameters:

bufferSize - if > 0, the internal buffer size, else use the default. Typically 100k - 1M for best results.

Returns:

Iterator over type PointObsDatatype, time order; or null if not available.

Throws:

java.io.IOException

getFullRange

Range getFullRange()

Deprecated.

Get the range for the entire trajectory.

getPointRange

Range getPointRange(int point)
             throws InvalidRangeException

Deprecated.

Get a range for a single point in the trajectory.

Throws:

InvalidRangeException

getRange

Range getRange(int start,
               int end,
               int stride)
        throws InvalidRangeException

Deprecated.

Get a range with the given start, end, and stride in the trajectory.

Throws:

InvalidRangeException

getTime

Array getTime(Range range)
       throws java.io.IOException,
              InvalidRangeException

Deprecated.

Get the time values on the given Range of the trajectory.

Throws:

java.io.IOException

InvalidRangeException

getLatitude

Array getLatitude(Range range)
           throws java.io.IOException,
                  InvalidRangeException

Deprecated.

Get the latitude values on the given Range of the trajectory.

Throws:

java.io.IOException

InvalidRangeException

getLongitude

Array getLongitude(Range range)
            throws java.io.IOException,
                   InvalidRangeException

Deprecated.

Get the longitude values on the given Range of the trajectory.

Throws:

java.io.IOException

InvalidRangeException

getElevation

Array getElevation(Range range)
            throws java.io.IOException,
                   InvalidRangeException

Deprecated.

Get the elevation values on the given Range of the trajectory.

Throws:

java.io.IOException

InvalidRangeException

getData

Array getData(Range range,
              java.lang.String parameterName)
       throws java.io.IOException,
              InvalidRangeException

Deprecated.

Get the values of the requested parameter on the given Range of the trajectory.

Throws:

java.io.IOException

InvalidRangeException