1 | /* |
---|
2 | * $Id: SGT3DGrid.java,v 1.2 2003/08/22 22:08:16 dwd Exp $ |
---|
3 | * |
---|
4 | * This software is provided by NOAA for full, free and open release. It is |
---|
5 | * understood by the recipient/user that NOAA assumes no liability for any |
---|
6 | * errors contained in the code. Although this software is released without |
---|
7 | * conditions or restrictions in its use, it is expected that appropriate |
---|
8 | * credit be given to its author and to the National Oceanic and Atmospheric |
---|
9 | * Administration should the software be included by the recipient as an |
---|
10 | * element in other product development. |
---|
11 | */ |
---|
12 | |
---|
13 | package gov.noaa.pmel.sgt.dm; |
---|
14 | |
---|
15 | import gov.noaa.pmel.util.GeoDate; |
---|
16 | import gov.noaa.pmel.util.Range2D; |
---|
17 | import gov.noaa.pmel.util.SoTRange; |
---|
18 | |
---|
19 | /** |
---|
20 | * Defines a data object to be of Grid type. Interpretation |
---|
21 | * of X and Y is determined by the <code>CoordinateSystem</code>. For |
---|
22 | * <code>Cartesian</code>, X and Y are the Cartesian coordinates. For |
---|
23 | * <code>Polar</code>, X and Y are R (radius) and Theta (angle), respectively. |
---|
24 | * |
---|
25 | * The <code>SGTGrid</code> interface only specifies the methods required |
---|
26 | * to access information. The methods used to construct an |
---|
27 | * object that implements <code>SGTGrid</code> is left to the developer. |
---|
28 | * |
---|
29 | * @author Donald Denbo |
---|
30 | * @version $Revision: 1.2 $, $Date: 2003/08/22 22:08:16 $ |
---|
31 | * @since 1.0 |
---|
32 | * @see SGTData |
---|
33 | * @see CoordinateSystem |
---|
34 | * @see Cartesian |
---|
35 | * @see Polar |
---|
36 | * @see SimpleGrid |
---|
37 | */ |
---|
38 | public interface SGT3DGrid extends SGTData { |
---|
39 | // additions to SGTData stuff |
---|
40 | |
---|
41 | /** |
---|
42 | * Returns true if the Z coordinate is Time. |
---|
43 | */ |
---|
44 | public boolean isZTime(); |
---|
45 | |
---|
46 | /** |
---|
47 | * Get the length of Z value array. |
---|
48 | */ |
---|
49 | public int getZSize(); |
---|
50 | /** |
---|
51 | * Get the range of measured values on this 3D grid. |
---|
52 | */ |
---|
53 | public Range2D getValRange(); |
---|
54 | /** |
---|
55 | * Get the array of temporal values. |
---|
56 | */ |
---|
57 | /** |
---|
58 | * Get the Value SGTMetaData. |
---|
59 | */ |
---|
60 | public SGTMetaData getValMetaData(); |
---|
61 | /** |
---|
62 | * Z edges available? |
---|
63 | */ |
---|
64 | public boolean hasZEdges(); |
---|
65 | /** |
---|
66 | * Get the Y coordinate edges. The YEdge length will |
---|
67 | * be one greater than the YArray length. |
---|
68 | */ |
---|
69 | public double[] getZEdges(); |
---|
70 | /** |
---|
71 | * Get the range of Y coordinate edges. |
---|
72 | */ |
---|
73 | public SoTRange getZEdgesRange(); |
---|
74 | } |
---|