src/ATCDCL/atis.hxx

   1 // atis.hxx -- ATIS class
   2 //
   3 // Written by David Luff, started October 2001.
   4 // Based on nav.hxx by Curtis Olson, started April 2000.
   5 //
   6 // Copyright (C) 2001  David C. Luff - david.luff@nottingham.ac.uk
   7 //
   8 // This program is free software; you can redistribute it and/or
   9 // modify it under the terms of the GNU General Public License as
  10 // published by the Free Software Foundation; either version 2 of the
  11 // License, or (at your option) any later version.
  12 //
  13 // This program is distributed in the hope that it will be useful, but
  14 // WITHOUT ANY WARRANTY; without even the implied warranty of
  15 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  16 // General Public License for more details.
  17 //
  18 // You should have received a copy of the GNU General Public License
  19 // along with this program; if not, write to the Free Software
  20 // Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
  21
  22
  23 #ifndef _FG_ATIS_HXX
  24 #define _FG_ATIS_HXX
  25
  26 #include <string>
  27 #include <iosfwd>
  28
  29 #include <simgear/compiler.h>
  30 #include <simgear/timing/sg_time.hxx>
  31
  32 #include "ATC.hxx"
  33
  34 //DCL - a complete guess for now.
  35 #define FG_ATIS_DEFAULT_RANGE 30
  36
  37
  38 class FGATIS : public FGATC {
  39
  40         //atc_type type;
  41         std::string transmission;       // The actual ATIS transmission
  42         // This is not stored in default.atis but is generated
  43         // from the prevailing conditions when required.
  44
  45         // for failure modeling
  46         std::string trans_ident;                // transmitted ident
  47         double old_volume;
  48         bool atis_failed;               // atis failed?
  49         time_t msg_time;                // for moderating error messages
  50         time_t cur_time;
  51         int msg_OK;
  52         int attention;
  53
  54         bool _prev_display;             // Previous value of _display flag
  55
  56         // Aircraft position
  57         // ATIS is actually a special case in that unlike other ATC eg.tower it doesn't actually know about
  58         // or the whereabouts of the aircraft it is transmitting to.  However, to ensure consistancy of
  59         // operation with the other ATC classes the ATIS class must calculate range to the aircraft in order
  60         // to decide whether to render the transmission - hence the users plane details must be stored.
  61         //SGPropertyNode_ptr airplane_lon_node;
  62         //SGPropertyNode_ptr airplane_lat_node;
  63         //SGPropertyNode_ptr airplane_elev_node;
  64
  65         public:
  66
  67         FGATIS(void);
  68         ~FGATIS(void);
  69         virtual void Init();
  70         void attend (int);
  71
  72         //run the ATIS instance
  73         void Update(double dt);
  74
  75         //inline void set_type(const atc_type tp) {type = tp;}
  76         inline const std::string& get_trans_ident() { return trans_ident; }
  77         inline void set_refname(const std::string& r) { refname = r; }
  78
  79         private:
  80
  81         std::string refname;            // Holds the refname of a transmission in progress
  82
  83         int GenTransmission(const int regen,
  84                 const int special);             // Generate the transmission string
  85
  86         friend std::istream& operator>> ( std::istream&, FGATIS& );
  87 };
  88
  89 typedef int (FGATIS::*int_getter)() const;
  90
  91 #endif // _FG_ATIS_HXX