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 <stdio.h>
  27 #include <string>
  28
  29 #include <simgear/compiler.h>
  30 #include <simgear/math/sg_geodesy.hxx>
  31 #include <simgear/misc/sgstream.hxx>
  32 #include <simgear/magvar/magvar.hxx>
  33 #include <simgear/timing/sg_time.hxx>
  34
  35 #  include <iosfwd>
  36
  37 #include "ATC.hxx"
  38
  39 //DCL - a complete guess for now.
  40 #define FG_ATIS_DEFAULT_RANGE 30
  41
  42 class FGATIS : public FGATC {
  43
  44         //atc_type type;
  45         std::string transmission;       // The actual ATIS transmission
  46         // This is not stored in default.atis but is generated
  47         // from the prevailing conditions when required.
  48
  49         // for failure modeling
  50         std::string trans_ident;                // transmitted ident
  51         bool atis_failed;               // atis failed?
  52
  53         // Aircraft position
  54         // ATIS is actually a special case in that unlike other ATC eg.tower it doesn't actually know about
  55         // or the whereabouts of the aircraft it is transmitting to.  However, to ensure consistancy of
  56         // operation with the other ATC classes the ATIS class must calculate range to the aircraft in order
  57         // to decide whether to render the transmission - hence the users plane details must be stored.
  58         //SGPropertyNode_ptr airplane_lon_node;
  59         //SGPropertyNode_ptr airplane_lat_node;
  60         //SGPropertyNode_ptr airplane_elev_node;
  61
  62         public:
  63
  64         FGATIS(void);
  65         ~FGATIS(void);
  66
  67         //run the ATIS instance
  68         void Update(double dt);
  69
  70         //inline void set_type(const atc_type tp) {type = tp;}
  71         inline const std::string& get_trans_ident() { return trans_ident; }
  72         inline void set_refname(const std::string& r) { refname = r; }
  73
  74         private:
  75
  76         std::string refname;            // Holds the refname of a transmission in progress
  77
  78         //Update the transmission string
  79         void UpdateTransmission(void);
  80
  81         friend std::istream& operator>> ( std::istream&, FGATIS& );
  82 };
  83
  84 #endif // _FG_ATIS_HXX