1 // FGATC - abstract base class for the various actual atc classes
2 // such as FGATIS, FGTower etc.
4 // Written by David Luff, started Feburary 2002.
6 // Copyright (C) 2002 David C. Luff - david.luff@nottingham.ac.uk
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.
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.
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.
25 #include <simgear/compiler.h>
26 #include <simgear/misc/sgstream.hxx>
27 #include <simgear/math/sg_geodesy.hxx>
28 #include <simgear/debug/logstream.hxx>
33 #include "ATCVoice.hxx"
35 SG_USING_STD(ostream);
50 // PlaneRec - a structure holding ATC-centric details of planes under control
51 // This might move or change eventually
58 // Possible types of ATC type that the radios may be tuned to.
59 // INVALID implies not tuned in to anything.
70 const int ATC_NUM_TYPES = 7;
72 // DCL - new experimental ATC data store
75 // I've deliberately used float instead of double here to keep the size down - we'll be storing thousands of these in memory.
76 // In fact, we could probably ditch x, y and z and generate on the fly as needed.
77 // On the other hand, we'll probably end up reading this data directly from the DAFIF eventually anyway!!
81 unsigned short int freq;
83 unsigned short int range;
88 // perhaps we could use an FGRunway instead of this.
89 // That wouldn't cache the orthopos though.
90 struct RunwayDetails {
91 Point3D threshold_pos;
92 Point3D end1ortho; // ortho projection end1 (the threshold ATM)
93 Point3D end2ortho; // ortho projection end2 (the take off end in the current hardwired scheme)
94 double hdg; // true runway heading
95 double length; // In *METERS*
96 double width; // ditto
100 ostream& operator << (ostream& os, atc_type atc);
109 // Run the internal calculations
110 // Derived classes should call this method from their own Update methods if they
111 // wish to use the response timer functionality.
112 virtual void Update(double dt);
114 // Recieve a coded callback from the ATC menu system based on the user's selection
115 virtual void ReceiveUserCallback(int code);
117 // Add plane to a stack
118 virtual void AddPlane(string pid);
120 // Remove plane from stack
121 virtual int RemovePlane();
123 // Indicate that this instance should output to the display if appropriate
124 virtual void SetDisplay();
126 // Indicate that this instance should not output to the display
127 virtual void SetNoDisplay();
129 // Generate the text of a message from its parameters and the current context.
130 virtual string GenText(const string& m, int c);
132 // Returns true if OK to transmit on this frequency
133 inline bool GetFreqClear() { return freqClear; }
134 // Indicate that the frequency is in use
135 inline void SetFreqInUse() { freqClear = false; receiving = true; }
136 // Transmission to the ATC is finished and a response is required
137 void SetResponseReqd(string rid);
138 // Transmission finished - let ATC decide if a response is reqd and clear freq if necessary
139 void NotifyTransmissionFinished(string rid);
140 // Transmission finished and no response required
141 inline void ReleaseFreq() { freqClear = true; receiving = false; } // TODO - check that the plane releasing the freq is the right one etc.
142 // The above 3 funcs under development!!
143 // The idea is that AI traffic or the user ATC dialog box calls FreqInUse() when they begin transmitting,
144 // and that the tower control sets freqClear back to true following a reply.
145 // AI traffic should check FreqClear() is true prior to transmitting.
146 // The user will just have to wait for a gap in dialog as in real life.
148 // Return the type of ATC station that the class represents
149 virtual atc_type GetType();
151 // Set the core ATC data
152 void SetData(ATCData* d);
154 inline double get_lon() const { return lon; }
155 inline void set_lon(const double ln) {lon = ln;}
156 inline double get_lat() const { return lat; }
157 inline void set_lat(const double lt) {lat = lt;}
158 inline double get_elev() const { return elev; }
159 inline void set_elev(const double ev) {elev = ev;}
160 inline double get_x() const { return x; }
161 inline void set_x(const double ecs) {x = ecs;}
162 inline double get_y() const { return y; }
163 inline void set_y(const double why) {y = why;}
164 inline double get_z() const { return z; }
165 inline void set_z(const double zed) {z = zed;}
166 inline int get_freq() const { return freq; }
167 inline void set_freq(const int fq) {freq = fq;}
168 inline int get_range() const { return range; }
169 inline void set_range(const int rg) {range = rg;}
170 inline const char* get_ident() { return ident.c_str(); }
171 inline void set_ident(const string id) {ident = id;}
172 inline const char* get_name() {return name.c_str();}
173 inline void set_name(const string nm) {name = nm;}
177 // Render a transmission
178 // Outputs the transmission either on screen or as audio depending on user preference
179 // The refname is a string to identify this sample to the sound manager
180 // The repeating flag indicates whether the message should be repeated continuously or played once.
181 void Render(string msg, string refname, bool repeating);
183 // Cease rendering a transmission.
184 // Requires the sound manager refname if audio, else "".
185 void NoRender(string refname);
187 double lon, lat, elev;
191 string ident; // Code of the airport its at.
192 string name; // Name transmitted in the broadcast.
194 // Rendering related stuff
195 bool voice; // Flag - true if we are using voice
196 bool playing; // Indicates a message in progress
197 bool voiceOK; // Flag - true if at least one voice has loaded OK
200 bool freqClear; // Flag to indicate if the frequency is clear of ongoing dialog
201 bool receiving; // Flag to indicate we are receiving a transmission
202 bool responseReqd; // Flag to indicate we should be responding to a request/report
203 bool runResponseCounter; // Flag to indicate the response counter should be run
204 double responseTime; // Time to take from end of request transmission to beginning of response
205 // The idea is that this will be slightly random.
206 double responseCounter; // counter to implement the above
207 string responseID; // ID of the plane to respond to
208 bool respond; // Flag to indicate now is the time to respond - ie set following the count down of the response timer.
209 // Derived classes only need monitor this flag, and use the response ID, as long as they call FGATC::Update(...)
213 operator >> ( istream& fin, ATCData& a )
236 return fin >> skipeol;
238 SG_LOG(SG_GENERAL, SG_ALERT, "Warning - unknown type \'" << tp << "\' found whilst reading ATC frequency data!\n");
240 return fin >> skipeol;
243 fin >> a.lat >> a.lon >> a.elev >> f >> a.range
248 if(ch != '"') a.name += ch;
251 fin.unsetf(ios::skipws);
253 if((ch == '"') || (ch == 0x0A)) {
255 } // we shouldn't need the 0x0A but it makes a nice safely in case someone leaves off the "
258 fin.setf(ios::skipws);
259 //cout << "Comm name = " << a.name << '\n';
261 a.freq = (int)(f*100.0 + 0.5);
263 // cout << a.ident << endl;
265 // generate cartesian coordinates
266 Point3D geod( a.lon * SGD_DEGREES_TO_RADIANS, a.lat * SGD_DEGREES_TO_RADIANS, a.elev );
267 Point3D cart = sgGeodToCart( geod );
272 return fin >> skipeol;
276 #endif // _FG_ATC_HXX