/****************************************************************************/
/* Copyright (c) 2000 MBARI                                                 */
/* MBARI Proprietary Information. All rights reserved.                      */
/****************************************************************************/
/* Summary  :                                                               */
/* Filename : Gps.h                                                   */
/* Author   :                                                               */
/* Project  :                                                               */
/* Version  : 1.0                                                           */
/* Created  : 02/07/2000                                                    */
/* Modified :                                                               */
/* Archived :                                                               */
/****************************************************************************/
/* Modification History:                                                    */
/****************************************************************************/

#ifndef _LOGGABLEGPS_H
#define _LOGGABLEGPS_H

#include "GpsIF.h"

/*
CLASS 
LoggableGps

DESCRIPTION
Abstract interface for NMEA GPS data. This interface is used
by GpsLog. Thus GpsLog can deal with any GPS device driver
that implemements LoggableGps.

AUTHOR
Tom O'Reilly

*/
class LoggableGps {

 public:

  ///////////////////////////////////////////////////////////////////////
  // Sample time
  virtual long sampleTime() = 0;

  ///////////////////////////////////////////////////////////////////////
  // Latitude (radians)
  virtual double latitude() = 0;

  ///////////////////////////////////////////////////////////////////////
  // Latitude hemisphere; 'N' or 'S'
  virtual char nsHemisphere() = 0;

  ///////////////////////////////////////////////////////////////////////
  // Longitude (radians)
  virtual double longitude() = 0;

  ///////////////////////////////////////////////////////////////////////
  // Longitude hemisphere; 'E' or 'W'
  virtual char ewHemisphere() = 0;

  ///////////////////////////////////////////////////////////////////////
  // GPS Quality
  virtual GpsIF::Quality quality() = 0;

  ///////////////////////////////////////////////////////////////////////
  // Number of satellites
  virtual short nSatellites() = 0;

  ///////////////////////////////////////////////////////////////////////
  // Horizontal dilution of precision
  virtual double hdop() = 0;

  ///////////////////////////////////////////////////////////////////////
  // Altitude above geoid (mean sea level)
  virtual double altitude() = 0;

  ///////////////////////////////////////////////////////////////////////
  // Height of geoid above WGS84 ellipsoid
  virtual double geoidHeight() = 0;

  ///////////////////////////////////////////////////////////////////////
  // Age of DGPS data (seconds)
  virtual short dgpsDataAge() = 0;

  ///////////////////////////////////////////////////////////////////////
  // DGPS reference station ID
  virtual short dgpsStationId() = 0;
};

#endif