ucar.nc2.ft2.simpgeometry.Line Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of org.gecko.ucar.netcdf Show documentation

Re-packaged Unidata netCDF

The newest version!

package ucar.nc2.ft2.simpgeometry;

import java.util.List;
import ucar.ma2.Array;
import ucar.nc2.Variable;
import ucar.nc2.dataset.NetcdfDataset;

/**
 * Generic interface for a Simple Geometry line.
 * 
 * @author [email protected]
 *
 */
public interface Line extends SimpleGeometry {
  /**
   * Add a point to the end of the line.
   *
   */
  void addPoint(double x, double y);

  /**
   * Returns the list of points which make up this line
   * 
   * @return points - the collection of points that make up this line
   */
  List getPoints();

  /**
   * Get the data associated with this line
   * 
   * @return data
   */
  Array getData();

  /**
   * If part of a multiline, returns the next line within that line
   * if it is present.
   * 
   * @return next line if present, null if not
   */
  Line getNext();

  /**
   * If part of a multiline, returns the previous line within that line
   * if it is present
   * 
   * @return previous line if present, null if not
   */
  Line getPrev();

  /**
   * Set the data associated with this Line
   * 
   * @param data - array of data to set to
   */
  void setData(Array data);

  /**
   * Sets the next line which make up the multiline which this line is a part of.
   */
  void setNext(Line next);


  /**
   * Sets the previous line which makes up the multiline which this line is a part of.
   */
  void setPrev(Line prev);

  /**
   * Given a dataset, construct a line from the variable which holds lines
   * and the index as given.
   * 
   * @param dataset Where the line variable resides
   * @param variable Which holds polygon information
   * @param index for Indexing within the polygon variable
   * 
   * @return the constructed Line with associated data
   */
  Line setupLine(NetcdfDataset dataset, Variable variable, int index);

}