package ucar.nc2.dt;

import ucar.ma2.Array;
import ucar.nc2.VariableSimpleIF;

import java.io.IOException;
import java.util.Date;

/**
 * A RadialDataset in which the radials can be grouped into sweeps.
 * A sweep has the same gate geometry for all radials in the sweep, and has a RadialDatasetSweep.Type.
 *
 * @author yuan
 * @version $Revision:51 $ $Date:2006-07-12 17:13:13Z $
 */
public interface RadialDatasetSweep extends ucar.nc2.dt.TypedDataset {
  /* definition of data format for level2*/
  public static final String LevelII = "Level II";

  /**  return radar name */
  public String getRadarID();

  /**  return radar name */
  public String getRadarName();

  /**  return data name */
  public String getDataFormat();

  /** If all the sweeps are the same type, return it here, else NONE */
  public RadialDatasetSweep.Type getCommonType();

  /** If all sweeps have the same origin, return it here, else null */
  public ucar.nc2.dt.EarthLocation  getCommonOrigin();

  /** Get the units of Calendar time.
   *  To get a Date, from a time value, call DateUnit.getStandardDate(double value).
   *  To get units as a String, call DateUnit.getUnitsString().
   */
  public ucar.nc2.units.DateUnit getTimeUnits();

  /**
   * Get the basic property of Radar
   * @return 1 if this is a station radar
  */
  public boolean isStationary();

  /**
   * Get the basic property of Radar
   * @return 0 if this is not a radial product
   */

 // public boolean isRadial();

  /**
   * Get the basic property of Radar,
   * @return 0 if there is only one sweep
   */
  public boolean isVolume();

  /** The radial data variables available in the dataset.
   * @return List of type RadialDatasetSweep.RadialVariable */
  public java.util.List getDataVariables();

  public interface RadialVariable extends ucar.nc2.VariableSimpleIF {
    /** @return the number of sweeps for this Variable */
    public int getNumSweeps();

    /** @return the ith sweep */
    public Sweep getSweep(int sweepNum);

    /** @return  data, of length getNumSweep() by getNumGates() by getNumRadials() */
    public float[] readAllData() throws java.io.IOException;
  }

  /** A sweep is 2D data using radial coordinate system (elevation, azimuth, radial distance) */
  public interface Sweep {
    /** @return the type of the Sweep */
    public RadialDatasetSweep.Type getType();

    /** @return the number of radials for this Sweep */
    public int getRadialNumber();

    /** @return the number of gates for all radials */
    public int getGateNumber();

    /** @return the beam width for all radials, in degrees */
    public float getBeamWidth();

    /** @return the Nyquist Frequency for all radials  */
    public float getNyquistFrequency();

    /**
     * Get the radial distance from origin to the start of the first data gate.
     * The radial distance to the ith gate = getRangeToFirstGate() + getGateSize() * i
     * @return distance to first gate in meters, for all radials */
    public float getRangeToFirstGate();

    /**
     *  Get the radial length of each data gate.
     * The radial distance to the ith gate = getRangeToFirstGate() + getGateSize() * i
     * @return gate size in meters,  for all radials */
    public float getGateSize();

    /** @return all the sweep data, of length getNumGates() by getNumRadials() */
    public float[] readData() throws java.io.IOException;

    /** @return the actual data, of length getNumGates() */
    public float[] readData(int radial) throws java.io.IOException;

    /** @return the elevation of the ith radial, in degrees */
    public float getElevation(int radial)  throws java.io.IOException;

    /** @return the average elevation of all the radials in the sweep, in degrees.
     * Only valid if getType() == TYPE_ */
    public float getMeanElevation();

    /** @return the azimuth of the ith radial, in degrees */
    public float getAzimuth(int radial) throws java.io.IOException;

    /** @return the average azimuth of all the radials in the sweep, in degrees.
     * Only valid if getType() == TYPE_ */
    public float getMeanAzimuth();

    /** @return the location of the origin of the ith radial. */
    public ucar.nc2.dt.EarthLocation getOrigin(int radial);

    /** @return the time of the ith radial, in units of getTimeUnits(). */
    public float getTime(int radial) throws IOException;

    /** @return the starting time of the sweep, in units of getTimeUnits(). */
    public Date getStartingTime();

    /** @return the ending time of the sweep, in units of getTimeUnits(). */
    public Date getEndingTime();
  }

  static public final class Type {
    private static java.util.ArrayList members = new java.util.ArrayList(20);

    public final static Type NONE = new Type("");

    private String name;
    private Type(String s) {
      this.name = s;
      members.add(this);
    }

    public static java.util.Collection getAllTypes() { return members; }

    /**
     * Find the DataType that matches this name, ignore case.
     * @param name : match this name
     * @return DataType or null if no match.
     */
    public static Type getType(String name) {
      if (name == null) return null;
      for (int i = 0; i < members.size(); i++) {
        Type m = (Type) members.get(i);
        if (m.name.equalsIgnoreCase( name))
          return m;
      }
      return null;
    }

    /** @return the type name. */
     public String toString() { return name; }

     /** Override Object.hashCode() to be consistent with this equals. */
     public int hashCode() { return name.hashCode(); }
     /** Type with same name are equal. */
     public boolean equals(Object o) {
       if (this == o) return true;
       if (!(o instanceof Type)) return false;
       return o.hashCode() == this.hashCode();
    }
  }

}


@@ -2047,24 +2047,8 @@
 p() 
-by getNumGates()
  by 
@@ -2055,32 +2055,48 @@
 getNumRadials() 
+by getNumGates()
 */%0A    public fl
@@ -3299,28 +3299,30 @@
 ength getNum
-Gate
+Radial
 s() by getNu
@@ -3322,26 +3322,23 @@
 y getNum
-Radial
+Gate
 s()
- 
 */%0A    p

comment change