]> git.mxchange.org Git - flightgear.git/blob - src/ATC/ATC.hxx
Improved tumbling behaviour -- the AI doesn't just freeze now, but
[flightgear.git] / 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 #include <simgear/misc/sgstream.hxx>
27 #include <simgear/math/sg_geodesy.hxx>
28 #include <simgear/debug/logstream.hxx>
29
30 #include STL_IOSTREAM
31 #include STL_STRING
32
33 #include "ATCVoice.hxx"
34
35 SG_USING_STD(ostream);
36 SG_USING_STD(string);
37 SG_USING_STD(ios);
38
39 enum plane_type {
40         UNKNOWN,
41         GA_SINGLE,
42         GA_HP_SINGLE,
43         GA_TWIN,
44         GA_JET,
45         MEDIUM,
46         HEAVY,
47         MIL_JET
48 };
49
50 // PlaneRec - a structure holding ATC-centric details of planes under control
51 // This might move or change eventually
52 struct PlaneRec {
53         plane_type type;
54         string callsign;
55         int squawkcode;
56 };
57
58 // Possible types of ATC type that the radios may be tuned to.
59 // INVALID implies not tuned in to anything.
60 enum atc_type {
61     INVALID,
62     ATIS,
63     GROUND,
64     TOWER,
65     APPROACH,
66     DEPARTURE,
67     ENROUTE
68 }; 
69
70 // DCL - new experimental ATC data store
71 struct ATCData {
72         atc_type type;
73         // I've deliberately used float instead of double here to keep the size down - we'll be storing thousands of these in memory.
74         // In fact, we could probably ditch x, y and z and generate on the fly as needed.
75         // On the other hand, we'll probably end up reading this data directly from the DAFIF eventually anyway!!
76         float lon, lat, elev;
77         float x, y, z;
78         //int freq;
79         unsigned short int freq;
80         //int range;
81         unsigned short int range;
82         string ident;
83         string name;
84 };
85
86 // perhaps we could use an FGRunway instead of this.
87 // That wouldn't cache the orthopos though.
88 struct RunwayDetails {
89         Point3D threshold_pos;
90         Point3D end1ortho;      // ortho projection end1 (the threshold ATM)
91         Point3D end2ortho;      // ortho projection end2 (the take off end in the current hardwired scheme)
92         double hdg;             // true runway heading
93         double length;  // In *METERS*
94         double width;   // ditto
95         string rwyID;
96 };
97
98 ostream& operator << (ostream& os, atc_type atc);
99
100 class FGATC {
101
102 public:
103
104     virtual ~FGATC();
105
106     // Run the internal calculations
107     virtual void Update(double dt);
108
109     // Add plane to a stack
110     virtual void AddPlane(string pid);
111
112     // Remove plane from stack
113     virtual int RemovePlane();
114
115     // Indicate that this instance should output to the display if appropriate 
116     virtual void SetDisplay();
117
118     // Indicate that this instance should not output to the display
119     virtual void SetNoDisplay();
120
121     // Return the type of ATC station that the class represents
122     virtual atc_type GetType();
123         
124         // Set the core ATC data
125         void SetData(ATCData* d);
126         
127         inline double get_lon() const { return lon; }
128         inline void set_lon(const double ln) {lon = ln;}
129         inline double get_lat() const { return lat; }
130         inline void set_lat(const double lt) {lat = lt;}
131         inline double get_elev() const { return elev; }
132         inline void set_elev(const double ev) {elev = ev;}
133         inline double get_x() const { return x; }
134         inline void set_x(const double ecs) {x = ecs;}
135         inline double get_y() const { return y; }
136         inline void set_y(const double why) {y = why;}
137         inline double get_z() const { return z; }
138         inline void set_z(const double zed) {z = zed;}
139         inline int get_freq() const { return freq; }
140         inline void set_freq(const int fq) {freq = fq;}
141         inline int get_range() const { return range; }
142         inline void set_range(const int rg) {range = rg;}
143         inline const char* get_ident() { return ident.c_str(); }
144         inline void set_ident(const string id) {ident = id;}
145         inline const char* get_name() {return name.c_str();}
146         inline void set_name(const string nm) {name = nm;}
147         
148 protected:
149
150         // Render a transmission
151         // Outputs the transmission either on screen or as audio depending on user preference
152         // The refname is a string to identify this sample to the sound manager
153         // The repeating flag indicates whether the message should be repeated continuously or played once.
154         void Render(string msg, string refname, bool repeating);
155
156         // Cease rendering a transmission.
157         // Requires the sound manager refname if audio, else "".
158         void NoRender(string refname);
159
160         double lon, lat, elev;
161         double x, y, z;
162         int freq;
163         int range;
164         string ident;           // Code of the airport its at.
165         string name;            // Name transmitted in the broadcast.
166         
167         // Rendering related stuff
168         bool voice;                     // Flag - true if we are using voice
169         bool playing;           // Indicates a message in progress      
170         bool voiceOK;           // Flag - true if at least one voice has loaded OK
171         FGATCVoice* vPtr;
172 };
173
174 inline istream&
175 operator >> ( istream& fin, ATCData& a )
176 {
177         double f;
178         char ch;
179         char tp;
180
181         fin >> tp;
182         
183         switch(tp) {
184         case 'I':
185                 a.type = ATIS;
186                 break;
187         case 'T':
188                 a.type = TOWER;
189                 break;
190         case 'G':
191                 a.type = GROUND;
192                 break;
193         case 'A':
194                 a.type = APPROACH;
195                 break;
196         case '[':
197                 a.type = INVALID;
198                 return fin >> skipeol;
199         default:
200                 SG_LOG(SG_GENERAL, SG_ALERT, "Warning - unknown type \'" << tp << "\' found whilst reading ATC frequency data!\n");
201                 a.type = INVALID;
202                 return fin >> skipeol;
203         }
204
205         fin >> a.lat >> a.lon >> a.elev >> f >> a.range 
206         >> a.ident;
207         
208         a.name = "";
209         fin >> ch;
210         a.name += ch;
211         while(1) {
212                 //in >> noskipws
213                 fin.unsetf(ios::skipws);
214                 fin >> ch;
215                 a.name += ch;
216                 if((ch == '"') || (ch == 0x0A)) {
217                         break;
218                 }   // we shouldn't need the 0x0A but it makes a nice safely in case someone leaves off the "
219         }
220         fin.setf(ios::skipws);
221         //cout << "Comm name = " << a.name << '\n';
222         
223         a.freq = (int)(f*100.0 + 0.5);
224         
225         // cout << a.ident << endl;
226         
227         // generate cartesian coordinates
228         Point3D geod( a.lon * SGD_DEGREES_TO_RADIANS, a.lat * SGD_DEGREES_TO_RADIANS, a.elev );
229         Point3D cart = sgGeodToCart( geod );
230         a.x = cart.x();
231         a.y = cart.y();
232         a.z = cart.z();
233         
234         return fin >> skipeol;
235 }
236
237
238 #endif  // _FG_ATC_HXX