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 // Possible types of ATC type that the radios may be tuned to.
  26 // INVALID implies not tuned in to anything.
  27 typedef enum atc_type {
  28     INVALID,
  29     ATIS,
  30     GROUND,
  31     TOWER,
  32     APPROACH,
  33     DEPARTURE,
  34     ENROUTE
  35 };
  36
  37 class FGATC {
  38
  39 public:
  40
  41     virtual ~FGATC();
  42
  43     // Run the internal calculations
  44     virtual void Update();
  45
  46     // Indicate that this instance should output to the display if appropriate
  47     virtual void SetDisplay();
  48
  49     // Indicate that this instance should not output to the display
  50     virtual void SetNoDisplay();
  51
  52     // Return the ATC station ident (generally the ICAO code of the airport)
  53     virtual const char* GetIdent();
  54
  55     // Return the type of ATC station that the class represents
  56     virtual atc_type GetType();
  57 };
  58
  59 #endif  // _FG_ATC_HXX