/*
 * $Id: IDV-Style.xjs,v 1.3 2007/02/16 19:18:30 dmurray Exp $
 *
 * Copyright 1998-2009 University Corporation for Atmospheric Research/Unidata
 *
 * Portions of this software were developed by the Unidata Program at the
 * University Corporation for Atmospheric Research.
 *
 * Access and use of this software shall impose the following obligations
 * and understandings on the user. The user is granted the right, without
 * any fee or cost, to use, copy, modify, alter, enhance and distribute
 * this software, and any derivative works thereof, and its supporting
 * documentation for any purpose whatsoever, provided that this entire
 * notice appears in all copies of the software, derivative works and
 * supporting documentation.  Further, UCAR requests that the user credit
 * UCAR/Unidata in any publications that result from the use of this
 * software or in any product that includes this software. The names UCAR
 * and/or Unidata, however, may not be used in any advertising or publicity
 * to endorse or promote any products or commercial entity unless specific
 * written permission is obtained from UCAR/Unidata. The user also
 * understands that UCAR/Unidata is not obligated to provide the user with
 * any support, consulting, training or assistance of any kind with regard
 * to the use, operation and performance of this software nor to provide
 * the user with any updates, revisions, new versions or "bug fixes."
 *
 * THIS SOFTWARE IS PROVIDED BY UCAR/UNIDATA "AS IS" AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL UCAR/UNIDATA BE LIABLE FOR ANY SPECIAL,
 * INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING
 * FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
 * NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
 * WITH THE ACCESS, USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package ucar.nc2.iosp.grid;

import java.util.Date;

/**
 * An interface for one 2D gridded data record (used by  GRIB, GEMPAK, McIDAS gridded data).
 * A collection of these records comprise a CDM variable, usually adding time and optionally vertical, and ensemble dimensions.
 *
 * @author rkambic
 */
public interface GridRecord {

  /**
   * Get the first vertical level of this GridRecord
   *
   * @return the first vertical level value
   */
  public double getLevel1();

  /**
   * Get the second vertical level of this GridRecord
   *
   * @return the second vertical level value
   */
  public double getLevel2();

  /**
   * Get the vertical level type of this GridRecord
   *
   * @return vertical level type
   */
  public int getLevelType1();

  /**
   * Get the vertical level type of this GridRecord
   *
   * @return vertical level type
   */
  public int getLevelType2();

  /**
   * Get the first reference time of this GridRecord
   *
   * @return reference time
   */
  public Date getReferenceTime();

  /**
   * Get the valid time for this GridRecord.
   *
   * @return valid time
   */
  public Date getValidTime();

  /**
   * Get valid time offset of this GridRecord
   *
   * @return time offset in minutes from getReferenceTime()
   *
  public int getValidTimeOffset(); */

  /**
   * Get the parameter name
   *
   * @return parameter name
   */
  public String getParameterName();

  /**
   * Get the parameter description
   *
   * @return parameter description
   */
  public String getParameterDescription();

  /**
   * Get the grid def record id
   *
   * @return parameter name
   */
  public String getGridDefRecordId();

  /**
   * Get the decimal scale of the values
   *
   * @return decimal scale
   */
  public int getDecimalScale();

  /**
   * Get the time unit as a code, which should be Grib2 table 4.4.
   *
   * @return the time unit as a code
   */
  public int getTimeUnit();


  /**
   * Get the time unit as a String. Must be able to create a udunit like:
   * String udunit = timeUnit + " since " + refDate
   * So this assumes that any conversion factor is applied to the value
   *
   * @return the time unit as a String
   */
  public String getTimeUdunitName();

  /**
   * A hash code to group records into a CDM variable
   *
   * @return group hash code
   */
  public int cdmVariableHash();

  /**
   * A unique name for the CDM variable, must be consistent with cdmVariableHash
   *
   * @return unique CDM variable name
   */
  public String cdmVariableName(GridTableLookup lookup, boolean useLevel, boolean useStat);

}