gov.noaa.pmel.sgt.dm
Interface SGTGrid

All Superinterfaces:
SGTData
All Known Implementing Classes:
SimpleGrid

public interface SGTGrid
extends SGTData

Defines a data object to be of Grid type. Interpretation of X and Y is determined by the CoordinateSystem. For Cartesian, X and Y are the Cartesian coordinates. For Polar, X and Y are R (radius) and Theta (angle), respectively. The SGTGrid interface only specifies the methods required to access information. The methods used to construct an object that implements SGTGrid is left to the developer.

Since:
1.0
Version:
$Revision$, $Date$
Author:
Donald Denbo
See Also:
SGTData, CoordinateSystem, Cartesian, Polar, SimpleGrid

Method Summary
 SGTGrid getAssociatedData()
          Get the associated data.
 GeoDateArray getGeoDateArray()
          Get the GeoDateArray object.
 GeoDateArray getGeoDateArrayEdges()
          Get the GeoDateArray object.
 GeoDate[] getTimeArray()
          Get the array of temporal values.
 GeoDate[] getTimeEdges()
          Get the Time edges.
 int getTSize()
          Get the length of temporal value array.
 double[] getXArray()
          Get the array of X values.
 double[] getXEdges()
          Get the X coordinate edges.
 SoTRange getXEdgesRange()
          Get the range of X coordinate edges.
 int getXSize()
          Get the length of X value array.
 double[] getYArray()
          Get the array of Y values.
 double[] getYEdges()
          Get the Y coordinate edges.
 SoTRange getYEdgesRange()
          Get the range of Y coordinate edges.
 int getYSize()
          Get the length of Y value array.
 double[] getZArray()
          Get the array of Z values.
 SGTMetaData getZMetaData()
          Get the Z SGTMetaData.
 Range2D getZRange()
          Get the range of Z values.
 boolean hasAssociatedData()
          Is there associated data available?
 boolean hasXEdges()
          Are X edges available?
 boolean hasYEdges()
          Are Y edges available?
 
Methods inherited from interface gov.noaa.pmel.sgt.dm.SGTData
addPropertyChangeListener, copy, getId, getKeyTitle, getTitle, getXMetaData, getXRange, getYMetaData, getYRange, isXTime, isYTime, removePropertyChangeListener
 

Method Detail

getXArray

double[] getXArray()
Get the array of X values.


getXSize

int getXSize()
Get the length of X value array.


getYArray

double[] getYArray()
Get the array of Y values.


getYSize

int getYSize()
Get the length of Y value array.


getZArray

double[] getZArray()
Get the array of Z values.


getZRange

Range2D getZRange()
Get the range of Z values.


getTimeArray

GeoDate[] getTimeArray()
Get the array of temporal values.


getGeoDateArray

GeoDateArray getGeoDateArray()
Get the GeoDateArray object.

Since:
3.0

getTSize

int getTSize()
Get the length of temporal value array.


getZMetaData

SGTMetaData getZMetaData()
Get the Z SGTMetaData.


getAssociatedData

SGTGrid getAssociatedData()
Get the associated data. The associated data must be of the same type (SGTGrid) and shape.


hasAssociatedData

boolean hasAssociatedData()
Is there associated data available?


hasXEdges

boolean hasXEdges()
Are X edges available?


getXEdges

double[] getXEdges()
Get the X coordinate edges. The XEdge length will be one greater than the XArray length.


getXEdgesRange

SoTRange getXEdgesRange()
Get the range of X coordinate edges.


hasYEdges

boolean hasYEdges()
Are Y edges available?


getYEdges

double[] getYEdges()
Get the Y coordinate edges. The YEdge length will be one greater than the YArray length.


getYEdgesRange

SoTRange getYEdgesRange()
Get the range of Y coordinate edges.


getTimeEdges

GeoDate[] getTimeEdges()
Get the Time edges. The TimeEdge length will be one greater than the TimeArray length.


getGeoDateArrayEdges

GeoDateArray getGeoDateArrayEdges()
Get the GeoDateArray object.

Since:
3.0