src/ATC/ATC.hxx

   1 // FGATC - abstract base class for the various actual atc classes
   2 // such as FGATIS, FGTower etc.
   3 //
   4 // Written by David Luff, started Feburary 2002.
   5 //
   6 // Copyright (C) 2002  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., 675 Mass Ave, Cambridge, MA 02139, USA.
  21
  22 #ifndef _FG_ATC_HXX
  23 #define _FG_ATC_HXX
  24
  25 #include <simgear/compiler.h>
  26
  27 #include STL_IOSTREAM
  28 #include STL_STRING
  29
  30 #ifndef SG_HAVE_NATIVE_SGI_COMPILERS
  31 SG_USING_STD(ostream);
  32 #endif
  33 SG_USING_STD(string);
  34
  35 // Possible types of ATC type that the radios may be tuned to.
  36 // INVALID implies not tuned in to anything.
  37 enum atc_type {
  38     INVALID,
  39     ATIS,
  40     GROUND,
  41     TOWER,
  42     APPROACH,
  43     DEPARTURE,
  44     ENROUTE
  45 };
  46
  47 ostream& operator << (ostream& os, atc_type atc);
  48
  49 class FGATC {
  50
  51 public:
  52
  53     virtual ~FGATC();
  54
  55     // Run the internal calculations
  56     virtual void Update();
  57
  58     // Add plane to a stack
  59     virtual void AddPlane(string pid);
  60
  61     // Remove plane from stack
  62     virtual int RemovePlane();
  63
  64     // Indicate that this instance should output to the display if appropriate
  65     virtual void SetDisplay();
  66
  67     // Indicate that this instance should not output to the display
  68     virtual void SetNoDisplay();
  69
  70     // Return the ATC station ident (generally the ICAO code of the airport)
  71     virtual const char* GetIdent();
  72
  73     // Return the type of ATC station that the class represents
  74     virtual atc_type GetType();
  75 };
  76
  77 #endif  // _FG_ATC_HXX