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     enum Coverage {
 134         COVERAGE_NIL = -1,
 135         COVERAGE_CLEAR = 0,
 136         COVERAGE_FEW = 1,
 137         COVERAGE_SCATTERED = 2,
 138         COVERAGE_BROKEN = 3,
 139         COVERAGE_OVERCAST = 4
 140     };
 141
 142         SGMetarCloud() : _coverage(COVERAGE_NIL), _altitude(NaN), _type(0), _type_long(0) {}
 143
 144         void set(double alt, Coverage cov = COVERAGE_NIL );
 145
 146         inline Coverage getCoverage() const { return _coverage; }
 147         inline double getAltitude_m() const { return _altitude; }
 148         inline double getAltitude_ft() const { return _altitude == NaN ? NaN : _altitude * SG_METER_TO_FEET; }
 149         inline const char *getTypeString() const { return _type; }
 150         inline const char *getTypeLongString() const { return _type_long; }
 151
 152 protected:
 153         Coverage _coverage;          // quarters: 0 -> clear ... 4 -> overcast
 154         double _altitude;       // 1000 m
 155         const char *_type;      // CU
 156         const char *_type_long; // cumulus
 157 };
 158
 159
 160 class SGMetar {
 161 public:
 162         SGMetar(const string& m, const string& proxy = "", const string& port = "",
 163                         const string &auth = "", const time_t time = 0);
 164         ~SGMetar();
 165
 166         enum ReportType {
 167                 NONE,
 168                 AUTO,
 169                 COR,
 170                 RTD
 171         };
 172
 173     enum Intensity {
 174         NIL = 0,
 175         LIGHT = 1,
 176         MODERATE = 2,
 177         HEAVY = 3
 178     };
 179
 180     struct Weather {
 181         Weather() { intensity = NIL; vincinity = false; }
 182         Intensity intensity;
 183         bool      vincinity;
 184         vector<string> descriptions;
 185         vector<string> phenomena;
 186     };
 187
 188         inline const char *getData()            const { return _data; }
 189         inline const char *getUnusedData()      const { return _m; }
 190         inline const bool getProxy()            const { return _x_proxy; }
 191         inline const char *getId()              const { return _icao; }
 192         inline int      getYear()               const { return _year; }
 193         inline int      getMonth()              const { return _month; }
 194         inline int      getDay()                const { return _day; }
 195         inline int      getHour()               const { return _hour; }
 196         inline int      getMinute()             const { return _minute; }
 197         inline int      getReportType()         const { return _report_type; }
 198
 199         inline int      getWindDir()            const { return _wind_dir; }
 200         inline double   getWindSpeed_mps()      const { return _wind_speed; }
 201         inline double   getWindSpeed_kmh()      const { return _wind_speed == NaN ? NaN : _wind_speed * SG_MPS_TO_KMH; }
 202         inline double   getWindSpeed_kt()       const { return _wind_speed == NaN ? NaN : _wind_speed * SG_MPS_TO_KT; }
 203         inline double   getWindSpeed_mph()      const { return _wind_speed == NaN ? NaN : _wind_speed * SG_MPS_TO_MPH; }
 204
 205         inline double   getGustSpeed_mps()      const { return _gust_speed; }
 206         inline double   getGustSpeed_kmh()      const { return _gust_speed == NaN ? NaN : _gust_speed * SG_MPS_TO_KMH; }
 207         inline double   getGustSpeed_kt()       const { return _gust_speed == NaN ? NaN : _gust_speed * SG_MPS_TO_KT; }
 208         inline double   getGustSpeed_mph()      const { return _gust_speed == NaN ? NaN : _gust_speed * SG_MPS_TO_MPH; }
 209
 210         inline int      getWindRangeFrom()      const { return _wind_range_from; }
 211         inline int      getWindRangeTo()        const { return _wind_range_to; }
 212
 213         inline const SGMetarVisibility& getMinVisibility()      const { return _min_visibility; }
 214         inline const SGMetarVisibility& getMaxVisibility()      const { return _max_visibility; }
 215         inline const SGMetarVisibility& getVertVisibility()     const { return _vert_visibility; }
 216         inline const SGMetarVisibility *getDirVisibility()      const { return _dir_visibility; }
 217
 218         inline double   getTemperature_C()      const { return _temp; }
 219         inline double   getTemperature_F()      const { return _temp == NaN ? NaN : 1.8 * _temp + 32; }
 220         inline double   getDewpoint_C()         const { return _dewp; }
 221         inline double   getDewpoint_F()         const { return _dewp == NaN ? NaN : 1.8 * _dewp + 32; }
 222         inline double   getPressure_hPa()       const { return _pressure == NaN ? NaN : _pressure / 100; }
 223         inline double   getPressure_inHg()      const { return _pressure == NaN ? NaN : _pressure * SG_PA_TO_INHG; }
 224
 225         inline int      getRain()               const { return _rain; }
 226         inline int      getHail()               const { return _hail; }
 227         inline int      getSnow()               const { return _snow; }
 228         inline bool     getCAVOK()              const { return _cavok; }
 229
 230         double          getRelHumidity()        const;
 231
 232         inline const vector<SGMetarCloud>& getClouds()  const   { return _clouds; }
 233         inline const map<string, SGMetarRunway>& getRunways()   const   { return _runways; }
 234         inline const vector<string>& getWeather()               const   { return _weather; }
 235     inline const vector<struct Weather> getWeather2()      const   { return _weather2; }
 236
 237 protected:
 238         string  _url;
 239         int     _grpcount;
 240         bool    _x_proxy;
 241         char    *_data;
 242         char    *_m;
 243         char    _icao[5];
 244         int     _year;
 245         int     _month;
 246         int     _day;
 247         int     _hour;
 248         int     _minute;
 249         int     _report_type;
 250         int     _wind_dir;
 251         double  _wind_speed;
 252         double  _gust_speed;
 253         int     _wind_range_from;
 254         int     _wind_range_to;
 255         double  _temp;
 256         double  _dewp;
 257         double  _pressure;
 258         int     _rain;
 259         int     _hail;
 260         int     _snow;
 261         bool    _cavok;
 262     vector<struct Weather> _weather2;
 263
 264         SGMetarVisibility               _min_visibility;
 265         SGMetarVisibility               _max_visibility;
 266         SGMetarVisibility               _vert_visibility;
 267         SGMetarVisibility               _dir_visibility[8];
 268         vector<SGMetarCloud>            _clouds;
 269         map<string, SGMetarRunway>      _runways;
 270         vector<string>                  _weather;
 271
 272         bool    scanPreambleDate();
 273         bool    scanPreambleTime();
 274         void    useCurrentDate();
 275
 276         bool    scanType();
 277         bool    scanId();
 278         bool    scanDate();
 279         bool    scanModifier();
 280         bool    scanWind();
 281         bool    scanVariability();
 282         bool    scanVisibility();
 283         bool    scanRwyVisRange();
 284         bool    scanSkyCondition();
 285         bool    scanWeather();
 286         bool    scanTemperature();
 287         bool    scanPressure();
 288         bool    scanRunwayReport();
 289         bool    scanWindShear();
 290         bool    scanTrendForecast();
 291         bool    scanColorState();
 292         bool    scanRemark();
 293         bool    scanRemainder();
 294
 295         int     scanNumber(char **str, int *num, int min, int max = 0);
 296         bool    scanBoundary(char **str);
 297         const struct Token *scanToken(char **str, const struct Token *list);
 298         char    *loadData(const char *id, const string& proxy, const string& port,
 299                         const string &auth, time_t time);
 300         void    normalizeData();
 301 };
 302
 303 #undef NaN
 304 #endif // _METAR_HXX