simgear/timing/timezone.h

   1 /* -*- Mode: C++ -*- *****************************************************
   2  * timezone.h
   3  * Written by Durk Talsma. Started July 1999.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Library General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library 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 GNU
  13  * Library General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program; if not, write to the Free Software
  17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  18  *
  19  **************************************************************************/
  20
  21 /** \file timezone.h
  22  *
  23  * Provides SGTimeZone and SGTimeZoneContainer
  24  *
  25  */
  26
  27 #ifndef _TIMEZONE_H_
  28 #define _TIMEZONE_H_
  29
  30 #include <stdio.h>
  31 #include <string>
  32
  33 #include <simgear/timing/geocoord.h>
  34
  35 /**
  36  * SGTimeZone is derived from geocoord, and stores the timezone centerpoint,
  37  * as well as the countrycode and the timezone descriptor. The latter is
  38  * used in order to get the local time.
  39  *
  40  */
  41
  42 class SGTimeZone : public SGGeoCoord
  43 {
  44
  45 private:
  46
  47   std::string countryCode;
  48   std::string descriptor;
  49
  50 public:
  51
  52     /**
  53      * Default constructor.
  54      */
  55     SGTimeZone() : SGGeoCoord()
  56     {
  57         countryCode.erase();
  58         descriptor.erase();
  59     };
  60
  61     /**
  62      * Build a timezone object with a specifed latitude, longitude, country
  63      * code, and descriptor
  64      * @param la latitude
  65      * @param lo longitude
  66      * @param cc country code
  67      * @param desc descriptor
  68      */
  69     SGTimeZone(float la, float lo, char* cc, char* desc);
  70
  71     /**
  72      * Build a timezone object from a textline in zone.tab
  73      * @param infoString the textline from zone.tab
  74      */
  75     SGTimeZone(const char *infoString);
  76
  77     /**
  78      * The copy constructor
  79      * @param other the source object
  80      */
  81     SGTimeZone(const SGTimeZone &other);
  82
  83     /**
  84      * Virutal destructor
  85      */
  86     virtual ~SGTimeZone() { };
  87
  88     /**
  89      * Return the descriptor string
  90      * @return descriptor string (char array)
  91      */
  92     virtual const char * getDescription() { return descriptor.c_str(); };
  93 };
  94
  95 /**
  96  * SGTimeZoneContainer is derived from SGGeoCoordContainer, and has some
  97  * added functionality.
  98  */
  99
 100 class SGTimeZoneContainer : public SGGeoCoordContainer
 101 {
 102  public:
 103   SGTimeZoneContainer(const char *filename);
 104   virtual ~SGTimeZoneContainer();
 105 };
 106
 107
 108
 109 #endif // _TIMEZONE_H_