1 | /* |
---|
2 | * $Id: SGTLine.java,v 1.7 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 | |
---|
18 | /** |
---|
19 | * Defines a data object to be of Line type. Interpretation |
---|
20 | * of X and Y is determined by the <code>CoordinateSystem</code>. For |
---|
21 | * <code>Cartesian</code>, X and Y are the Cartesian coordinates. For |
---|
22 | * <code>Polar</code>, |
---|
23 | * X and Y are R (radius) and Theta (angle), respectively. |
---|
24 | * |
---|
25 | * The <code>SGTLine</code> interfaces only specifies the methods required |
---|
26 | * to access information. The methods used to construct an |
---|
27 | * object that implements <code>SGTLine</code> is left to the developer. |
---|
28 | * |
---|
29 | * @author Donald Denbo |
---|
30 | * @version $Revision: 1.7 $, $Date: 2003/08/22 23:02:38 $ |
---|
31 | * @since 1.0 |
---|
32 | * @see SGTData |
---|
33 | * @see CoordinateSystem |
---|
34 | * @see Cartesian |
---|
35 | * @see Polar |
---|
36 | * @see SimpleLine |
---|
37 | */ |
---|
38 | public interface SGTLine extends SGTData { |
---|
39 | /** |
---|
40 | * Get the array of X values. |
---|
41 | */ |
---|
42 | public double[] getXArray(); |
---|
43 | /** |
---|
44 | * Get the array of Y values. |
---|
45 | */ |
---|
46 | public double[] getYArray(); |
---|
47 | /** |
---|
48 | * Get the array of Time values. |
---|
49 | */ |
---|
50 | public GeoDate[] getTimeArray(); |
---|
51 | /** |
---|
52 | * Get the <code>GeoDateArray</code> object. |
---|
53 | * |
---|
54 | * @since 3.0 |
---|
55 | */ |
---|
56 | public GeoDateArray getGeoDateArray(); |
---|
57 | /** |
---|
58 | * Get the associated data. The associated data must |
---|
59 | * be of the same type (SGTLine) and length. The Y |
---|
60 | * array will be used. |
---|
61 | */ |
---|
62 | public SGTLine getAssociatedData(); |
---|
63 | /** |
---|
64 | * Is there associated data available? |
---|
65 | */ |
---|
66 | public boolean hasAssociatedData(); |
---|
67 | } |
---|