simgear/environment/metar.hxx

   1 // metar interface class
   2 //
   3 // Written by Melchior FRANZ, started December 2003.
   4 //
   5 // Copyright (C) 2003  Melchior FRANZ - mfranz@aon.at
   6 //
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License as
   9 // published by the Free Software Foundation; either version 2 of the
  10 // License, or (at your option) any later version.
  11 //
  12 // This program is distributed in the hope that it will be useful, but
  13 // WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15 // General Public License for more details.
  16 //
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software
  19 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  20 //
  21 // $Id$
  22
  23 #ifndef _METAR_HXX
  24 #define _METAR_HXX
  25
  26 #include <vector>
  27 #include <map>
  28 #include <string>
  29
  30 #include <simgear/constants.h>
  31
  32 using std::vector;
  33 using std::map;
  34 using std::string;
  35
  36 const double SGMetarNaN = -1E20;
  37 #define NaN SGMetarNaN
  38
  39 struct Token {
  40         const char *id;
  41         const char *text;
  42 };
  43
  44
  45 class SGMetar;
  46
  47 class SGMetarVisibility {
  48         friend class SGMetar;
  49 public:
  50         SGMetarVisibility() :
  51                 _distance(NaN),
  52                 _direction(-1),
  53                 _modifier(EQUALS),
  54                 _tendency(NONE) {}
  55
  56         enum Modifier {
  57                 NOGO,
  58                 EQUALS,
  59                 LESS_THAN,
  60                 GREATER_THAN
  61         };
  62
  63         enum Tendency {
  64                 NONE,
  65                 STABLE,
  66                 INCREASING,
  67                 DECREASING
  68         };
  69
  70         void set(double dist, int dir = -1, int mod = -1, int tend = -1);
  71
  72         inline double   getVisibility_m()       const { return _distance; }
  73         inline double   getVisibility_ft()      const { return _distance == NaN ? NaN : _distance * SG_METER_TO_FEET; }
  74         inline double   getVisibility_sm()      const { return _distance == NaN ? NaN : _distance * SG_METER_TO_SM; }
  75         inline int      getDirection()          const { return _direction; }
  76         inline int      getModifier()           const { return _modifier; }
  77         inline int      getTendency()           const { return _tendency; }
  78
  79 protected:
  80         double  _distance;
  81         int     _direction;
  82         int     _modifier;
  83         int     _tendency;
  84 };
  85
  86
  87 // runway condition (surface and visibility)
  88 class SGMetarRunway {
  89         friend class SGMetar;
  90 public:
  91         SGMetarRunway() :
  92                 _deposit(-1),
  93                 _deposit_string(0),
  94                 _extent(-1),
  95                 _extent_string(0),
  96                 _depth(NaN),
  97                 _friction(NaN),
  98                 _friction_string(0),
  99                 _comment(0),
 100                 _wind_shear(false) {}
 101
 102         inline int                      getDeposit()            const { return _deposit; }
 103         inline const char               *getDepositString()     const { return _deposit_string; }
 104         inline double                   getExtent()             const { return _extent; }
 105         inline const char               *getExtentString()      const { return _extent_string; }
 106         inline double                   getDepth()              const { return _depth; }
 107         inline double                   getFriction()           const { return _friction; }
 108         inline const char               *getFrictionString()    const { return _friction_string; }
 109         inline const char               *getComment()           const { return _comment; }
 110         inline const bool               getWindShear()          const { return _wind_shear; }
 111         inline const SGMetarVisibility& getMinVisibility()      const { return _min_visibility; }
 112         inline const SGMetarVisibility& getMaxVisibility()      const { return _max_visibility; }
 113
 114 protected:
 115         SGMetarVisibility _min_visibility;
 116         SGMetarVisibility _max_visibility;
 117         int             _deposit;
 118         const char      *_deposit_string;
 119         int             _extent;
 120         const char      *_extent_string;
 121         double          _depth;
 122         double          _friction;
 123         const char      *_friction_string;
 124         const char      *_comment;
 125         bool            _wind_shear;
 126 };
 127
 128
 129 // cloud layer
 130 class SGMetarCloud {
 131         friend class SGMetar;
 132 public:
 133         SGMetarCloud() : _coverage(-1), _altitude(NaN), _type(0), _type_long(0) {}
 134
 135         void set(double alt, int cov = -1);
 136
 137         inline int getCoverage() const { return _coverage; }
 138         inline double getAltitude_m() const { return _altitude; }
 139         inline double getAltitude_ft() const { return _altitude == NaN ? NaN : _altitude * SG_METER_TO_FEET; }
 140         inline const char *getTypeString() const { return _type; }
 141         inline const char *getTypeLongString() const { return _type_long; }
 142
 143 protected:
 144         int _coverage;          // quarters: 0 -> clear ... 4 -> overcast
 145         double _altitude;       // 1000 m
 146         const char *_type;      // CU
 147         const char *_type_long; // cumulus
 148 };
 149
 150
 151 class SGMetar {
 152 public:
 153         SGMetar(const string& m, const string& proxy = "", const string& port = "",
 154                         const string &auth = "", const time_t time = 0);
 155         ~SGMetar();
 156
 157         enum ReportType {
 158                 NONE,
 159                 AUTO,
 160                 COR,
 161                 RTD
 162         };
 163
 164         inline const char *getData()            const { return _data; }
 165         inline const char *getUnusedData()      const { return _m; }
 166         inline const bool getProxy()            const { return _x_proxy; }
 167         inline const char *getId()              const { return _icao; }
 168         inline int      getYear()               const { return _year; }
 169         inline int      getMonth()              const { return _month; }
 170         inline int      getDay()                const { return _day; }
 171         inline int      getHour()               const { return _hour; }
 172         inline int      getMinute()             const { return _minute; }
 173         inline int      getReportType()         const { return _report_type; }
 174
 175         inline int      getWindDir()            const { return _wind_dir; }
 176         inline double   getWindSpeed_mps()      const { return _wind_speed; }
 177         inline double   getWindSpeed_kmh()      const { return _wind_speed == NaN ? NaN : _wind_speed * SG_MPS_TO_KMH; }
 178         inline double   getWindSpeed_kt()       const { return _wind_speed == NaN ? NaN : _wind_speed * SG_MPS_TO_KT; }
 179         inline double   getWindSpeed_mph()      const { return _wind_speed == NaN ? NaN : _wind_speed * SG_MPS_TO_MPH; }
 180
 181         inline double   getGustSpeed_mps()      const { return _gust_speed; }
 182         inline double   getGustSpeed_kmh()      const { return _gust_speed == NaN ? NaN : _gust_speed * SG_MPS_TO_KMH; }
 183         inline double   getGustSpeed_kt()       const { return _gust_speed == NaN ? NaN : _gust_speed * SG_MPS_TO_KT; }
 184         inline double   getGustSpeed_mph()      const { return _gust_speed == NaN ? NaN : _gust_speed * SG_MPS_TO_MPH; }
 185
 186         inline int      getWindRangeFrom()      const { return _wind_range_from; }
 187         inline int      getWindRangeTo()        const { return _wind_range_to; }
 188
 189         inline const SGMetarVisibility& getMinVisibility()      const { return _min_visibility; }
 190         inline const SGMetarVisibility& getMaxVisibility()      const { return _max_visibility; }
 191         inline const SGMetarVisibility& getVertVisibility()     const { return _vert_visibility; }
 192         inline const SGMetarVisibility *getDirVisibility()      const { return _dir_visibility; }
 193
 194         inline double   getTemperature_C()      const { return _temp; }
 195         inline double   getTemperature_F()      const { return _temp == NaN ? NaN : 1.8 * _temp + 32; }
 196         inline double   getDewpoint_C()         const { return _dewp; }
 197         inline double   getDewpoint_F()         const { return _dewp == NaN ? NaN : 1.8 * _dewp + 32; }
 198         inline double   getPressure_hPa()       const { return _pressure == NaN ? NaN : _pressure / 100; }
 199         inline double   getPressure_inHg()      const { return _pressure == NaN ? NaN : _pressure * SG_PA_TO_INHG; }
 200
 201         inline int      getRain()               const { return _rain; }
 202         inline int      getHail()               const { return _hail; }
 203         inline int      getSnow()               const { return _snow; }
 204         inline bool     getCAVOK()              const { return _cavok; }
 205
 206         double          getRelHumidity()        const;
 207
 208         inline const vector<SGMetarCloud>& getClouds()  const   { return _clouds; }
 209         inline const map<string, SGMetarRunway>& getRunways()   const   { return _runways; }
 210         inline const vector<string>& getWeather()               const   { return _weather; }
 211
 212 protected:
 213         string  _url;
 214         int     _grpcount;
 215         bool    _x_proxy;
 216         char    *_data;
 217         char    *_m;
 218         char    _icao[5];
 219         int     _year;
 220         int     _month;
 221         int     _day;
 222         int     _hour;
 223         int     _minute;
 224         int     _report_type;
 225         int     _wind_dir;
 226         double  _wind_speed;
 227         double  _gust_speed;
 228         int     _wind_range_from;
 229         int     _wind_range_to;
 230         double  _temp;
 231         double  _dewp;
 232         double  _pressure;
 233         int     _rain;
 234         int     _hail;
 235         int     _snow;
 236         bool    _cavok;
 237
 238         SGMetarVisibility               _min_visibility;
 239         SGMetarVisibility               _max_visibility;
 240         SGMetarVisibility               _vert_visibility;
 241         SGMetarVisibility               _dir_visibility[8];
 242         vector<SGMetarCloud>            _clouds;
 243         map<string, SGMetarRunway>      _runways;
 244         vector<string>                  _weather;
 245
 246         bool    scanPreambleDate();
 247         bool    scanPreambleTime();
 248         void    useCurrentDate();
 249
 250         bool    scanType();
 251         bool    scanId();
 252         bool    scanDate();
 253         bool    scanModifier();
 254         bool    scanWind();
 255         bool    scanVariability();
 256         bool    scanVisibility();
 257         bool    scanRwyVisRange();
 258         bool    scanSkyCondition();
 259         bool    scanWeather();
 260         bool    scanTemperature();
 261         bool    scanPressure();
 262         bool    scanRunwayReport();
 263         bool    scanWindShear();
 264         bool    scanTrendForecast();
 265         bool    scanColorState();
 266         bool    scanRemark();
 267         bool    scanRemainder();
 268
 269         int     scanNumber(char **str, int *num, int min, int max = 0);
 270         bool    scanBoundary(char **str);
 271         const struct Token *scanToken(char **str, const struct Token *list);
 272         char    *loadData(const char *id, const string& proxy, const string& port,
 273                         const string &auth, time_t time);
 274         void    normalizeData();
 275 };
 276
 277 #undef NaN
 278 #endif // _METAR_HXX