1 | /* |
---|
2 | * $Id: SGTGrid.java,v 1.10 2003/08/22 23:02:38 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.GeoDateArray; |
---|
17 | import gov.noaa.pmel.util.Range2D; |
---|
18 | import gov.noaa.pmel.util.SoTRange; |
---|
19 | |
---|
20 | /** |
---|
21 | * Defines a data object to be of Grid type. Interpretation |
---|
22 | * of X and Y is determined by the <code>CoordinateSystem</code>. For |
---|
23 | * <code>Cartesian</code>, X and Y are the Cartesian coordinates. For |
---|
24 | * <code>Polar</code>, X and Y are R (radius) and Theta (angle), respectively. |
---|
25 | * |
---|
26 | * The <code>SGTGrid</code> interface only specifies the methods required |
---|
27 | * to access information. The methods used to construct an |
---|
28 | * object that implements <code>SGTGrid</code> is left to the developer. |
---|
29 | * |
---|
30 | * @author Donald Denbo |
---|
31 | * @version $Revision: 1.10 $, $Date: 2003/08/22 23:02:38 $ |
---|
32 | * @since 1.0 |
---|
33 | * @see SGTData |
---|
34 | * @see CoordinateSystem |
---|
35 | * @see Cartesian |
---|
36 | * @see Polar |
---|
37 | * @see SimpleGrid |
---|
38 | */ |
---|
39 | public interface SGTGrid extends SGTData { |
---|
40 | /** |
---|
41 | * Get the array of X values. |
---|
42 | */ |
---|
43 | public double[] getXArray(); |
---|
44 | /** |
---|
45 | * Get the length of X value array. |
---|
46 | */ |
---|
47 | public int getXSize(); |
---|
48 | /** |
---|
49 | * Get the array of Y values. |
---|
50 | */ |
---|
51 | public double[] getYArray(); |
---|
52 | /** |
---|
53 | * Get the length of Y value array. |
---|
54 | */ |
---|
55 | public int getYSize(); |
---|
56 | /** |
---|
57 | * Get the array of Z values. |
---|
58 | */ |
---|
59 | public double[] getZArray(); |
---|
60 | /** |
---|
61 | * Get the range of Z values. |
---|
62 | */ |
---|
63 | public Range2D getZRange(); |
---|
64 | /** |
---|
65 | * Get the array of temporal values. |
---|
66 | */ |
---|
67 | public GeoDate[] getTimeArray(); |
---|
68 | /** |
---|
69 | * Get the <code>GeoDateArray</code> object. |
---|
70 | * |
---|
71 | * @since 3.0 |
---|
72 | */ |
---|
73 | public GeoDateArray getGeoDateArray(); |
---|
74 | /** |
---|
75 | * Get the length of temporal value array. |
---|
76 | */ |
---|
77 | public int getTSize(); |
---|
78 | /** |
---|
79 | * Get the Z SGTMetaData. |
---|
80 | */ |
---|
81 | public SGTMetaData getZMetaData(); |
---|
82 | /** |
---|
83 | * Get the associated data. The associated data must |
---|
84 | * be of the same type (SGTGrid) and shape. |
---|
85 | */ |
---|
86 | public SGTGrid getAssociatedData(); |
---|
87 | /** |
---|
88 | * Is there associated data available? |
---|
89 | */ |
---|
90 | public boolean hasAssociatedData(); |
---|
91 | /** |
---|
92 | * Are X edges available? |
---|
93 | */ |
---|
94 | public boolean hasXEdges(); |
---|
95 | /** |
---|
96 | * Get the X coordinate edges. The XEdge length will |
---|
97 | * be one greater than the XArray length. |
---|
98 | */ |
---|
99 | public double[] getXEdges(); |
---|
100 | /** |
---|
101 | * Get the range of X coordinate edges. |
---|
102 | */ |
---|
103 | public SoTRange getXEdgesRange(); |
---|
104 | /** |
---|
105 | * Are Y edges available? |
---|
106 | */ |
---|
107 | public boolean hasYEdges(); |
---|
108 | /** |
---|
109 | * Get the Y coordinate edges. The YEdge length will |
---|
110 | * be one greater than the YArray length. |
---|
111 | */ |
---|
112 | public double[] getYEdges(); |
---|
113 | /** |
---|
114 | * Get the range of Y coordinate edges. |
---|
115 | */ |
---|
116 | public SoTRange getYEdgesRange(); |
---|
117 | /** |
---|
118 | * Get the Time edges. The TimeEdge length will |
---|
119 | * be one greater than the TimeArray length. |
---|
120 | */ |
---|
121 | public GeoDate[] getTimeEdges(); |
---|
122 | /** |
---|
123 | * Get the <code>GeoDateArray</code> object. |
---|
124 | * |
---|
125 | * @since 3.0 |
---|
126 | */ |
---|
127 | public GeoDateArray getGeoDateArrayEdges(); |
---|
128 | } |
---|