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 <iostream>
  28 #include <string>
  29
  30 SG_USING_STD(ostream);
  31 SG_USING_STD(string);
  32
  33 // Possible types of ATC type that the radios may be tuned to.
  34 // INVALID implies not tuned in to anything.
  35 enum atc_type {
  36     INVALID,
  37     ATIS,
  38     GROUND,
  39     TOWER,
  40     APPROACH,
  41     DEPARTURE,
  42     ENROUTE
  43 };
  44
  45 ostream& operator << (ostream& os, atc_type atc);
  46
  47 class FGATC {
  48
  49 public:
  50
  51     virtual ~FGATC();
  52
  53     // Run the internal calculations
  54     virtual void Update();
  55
  56     // Add plane to a stack
  57     virtual void AddPlane(string pid);
  58
  59     // Remove plane from stack
  60     virtual int RemovePlane();
  61
  62     // Indicate that this instance should output to the display if appropriate
  63     virtual void SetDisplay();
  64
  65     // Indicate that this instance should not output to the display
  66     virtual void SetNoDisplay();
  67
  68     // Return the ATC station ident (generally the ICAO code of the airport)
  69     virtual const char* GetIdent();
  70
  71     // Return the type of ATC station that the class represents
  72     virtual atc_type GetType();
  73 };
  74
  75 #endif  // _FG_ATC_HXX