geo/tcSrtmCache.h

   1 /***************************************************************************
   2  *   This file is part of Tecorrec.                                        *
   3  *   Copyright 2008 James Hogan <james@albanarts.com>                      *
   4  *                                                                         *
   5  *   Tecorrec is free software: you can redistribute it and/or modify      *
   6  *   it under the terms of the GNU General Public License as published by  *
   7  *   the Free Software Foundation, either version 2 of the License, or     *
   8  *   (at your option) any later version.                                   *
   9  *                                                                         *
  10  *   Tecorrec is distributed in the hope that it will be useful,           *
  11  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  12  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  13  *   GNU General Public License for more details.                          *
  14  *                                                                         *
  15  *   You should have received a copy of the GNU General Public License     *
  16  *   along with Tecorrec.  If not, write to the Free Software Foundation,  *
  17  *   Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.   *
  18  ***************************************************************************/
  19
  20 #ifndef _tcSrtmCache_h_
  21 #define _tcSrtmCache_h_
  22
  23 /**
  24  * @file tcSrtmCache.h
  25  * @brief Manages cache of SRTM data.
  26  */
  27
  28 class tcSrtmData;
  29 class tcGeo;
  30
  31 /** Manages cache of SRTM data.
  32  * Obtains SRTM elevation data blocks, downloading from nasa if necessary.
  33  *
  34  * FTP site: ftp://e0srp01u.ecs.nasa.gov/
  35  */
  36 class tcSrtmCache
  37 {
  38   public:
  39
  40     /*
  41      * Constructors + destructor
  42      */
  43
  44     /// Primary constructor.
  45     tcSrtmCache();
  46
  47     /// Destructor.
  48     virtual ~tcSrtmCache();
  49
  50     /*
  51      * Main interface
  52      */
  53
  54     /** Load raw SRTM height file.
  55      * Download the file if necessary.
  56      * @param lon Longitude in degrees.
  57      * @param lat Latitude in degrees.
  58      * @returns SRTM data for the chunk containing (@p lon, @p lat) or 0.
  59      */
  60     tcSrtmData* loadData(int lon, int lat);
  61
  62     /** Load raw SRTM height file.
  63      * Download the file if necessary.
  64      * @param coord Geographical coordinate.
  65      * @returns SRTM data for the chunk containing (@p lon, @p lat) or 0.
  66      */
  67     tcSrtmData* loadData(const tcGeo& coord);
  68 };
  69
  70 #endif
  71