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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
25 #include <simgear/constants.h>
26 #include <simgear/compiler.h>
27 #include <simgear/props/props.hxx>
28 #include <simgear/misc/sgstream.hxx>
29 #include <simgear/math/sg_geodesy.hxx>
30 #include <simgear/debug/logstream.hxx>
31 #include <simgear/structure/SGSharedPtr.hxx>
36 #include "ATCVoice.hxx"
40 // Convert a frequency in MHz to tens of kHz
41 // so we can use it e.g. as an index into commlist_freq
43 // If freq > 1000 assume it's already in tens of KHz;
44 // otherwise assume MHz.
46 // Note: 122.375 must be rounded DOWN to 12237
47 // in order to be consistent with apt.dat et cetera.
48 inline int kHz10(double freq)
50 if (freq > 1000.) return int(freq);
51 return int(freq*100.0 + 0.25);
65 // PlaneRec - a structure holding ATC-centric details of planes under control
66 // This might move or change eventually
73 // Possible types of ATC type that the radios may be tuned to.
74 // INVALID implies not tuned in to anything.
83 INVALID /* must be last element; see ATC_NUM_TYPES */
86 const int ATC_NUM_TYPES = 1 + INVALID;
88 // DCL - new experimental ATC data store
93 unsigned short int freq;
94 unsigned short int range;
99 // perhaps we could use an FGRunway instead of this.
100 // That wouldn't cache the orthopos though.
101 struct RunwayDetails {
102 SGGeod threshold_pos;
103 SGVec3d end1ortho; // ortho projection end1 (the threshold ATM)
104 SGVec3d end2ortho; // ortho projection end2 (the take off end in the current hardwired scheme)
105 double hdg; // true runway heading
106 double length; // In *METERS*
107 double width; // ditto
109 int patternDirection; // -1 for left, 1 for right
112 std::ostream& operator << (std::ostream& os, atc_type atc);
115 friend class FGATCMgr;
121 virtual void Init()=0;
123 // Run the internal calculations
124 // Derived classes should call this method from their own Update methods if they
125 // wish to use the response timer functionality.
126 virtual void Update(double dt);
128 // Recieve a coded callback from the ATC menu system based on the user's selection
129 virtual void ReceiveUserCallback(int code);
131 // Add plane to a stack
132 virtual void AddPlane(const std::string& pid);
134 // Remove plane from stack
135 virtual int RemovePlane();
137 // Indicate that this instance should output to the display if appropriate
138 inline void SetDisplay() { _display = true; }
140 // Indicate that this instance should not output to the display
141 inline void SetNoDisplay() { _display = false; }
143 // Generate the text of a message from its parameters and the current context.
144 virtual std::string GenText(const std::string& m, int c);
146 // Returns true if OK to transmit on this frequency
147 inline bool GetFreqClear() { return freqClear; }
148 // Indicate that the frequency is in use
149 inline void SetFreqInUse() { freqClear = false; receiving = true; }
150 // Transmission to the ATC is finished and a response is required
151 void SetResponseReqd(const std::string& rid);
152 // Transmission finished - let ATC decide if a response is reqd and clear freq if necessary
153 void NotifyTransmissionFinished(const std::string& rid);
154 // Transmission finished and no response required
155 inline void ReleaseFreq() { freqClear = true; receiving = false; } // TODO - check that the plane releasing the freq is the right one etc.
156 // The above 3 funcs under development!!
157 // The idea is that AI traffic or the user ATC dialog box calls FreqInUse() when they begin transmitting,
158 // and that the tower control sets freqClear back to true following a reply.
159 // AI traffic should check FreqClear() is true prior to transmitting.
160 // The user will just have to wait for a gap in dialog as in real life.
162 // Return the type of ATC station that the class represents
163 inline atc_type GetType() { return _type; }
165 // Set the core ATC data
166 void SetData(ATCData* d);
168 inline int get_freq() const { return freq; }
169 inline void set_freq(const int fq) {freq = fq;}
170 inline int get_range() const { return range; }
171 inline void set_range(const int rg) {range = rg;}
172 inline const std::string& get_ident() { return ident; }
173 inline void set_ident(const std::string& id) { ident = id; }
174 inline const std::string& get_name() { return name; }
175 inline void set_name(const std::string& nm) { name = nm; }
179 // Render a transmission
180 // Outputs the transmission either on screen or as audio depending on user preference
181 // The refname is a string to identify this sample to the sound manager
182 // The repeating flag indicates whether the message should be repeated continuously or played once.
183 void Render(std::string& msg, const float volume = 1.0,
184 const std::string& refname = "", bool repeating = false);
186 // Cease rendering all transmission from this station.
187 // Requires the sound manager refname if audio, else "".
188 void NoRender(const std::string& refname);
190 // Transmit a message when channel becomes free of other dialog
191 void Transmit(int callback_code = 0);
193 // Transmit a message if channel becomes free within timeout (seconds). timeout of zero implies no limit
194 void ConditionalTransmit(double timeout, int callback_code = 0);
196 // Transmit regardless of other dialog on the channel eg emergency
197 void ImmediateTransmit(int callback_code = 0);
199 virtual void ProcessCallback(int code);
204 std::map<std::string,int> active_on;
207 std::string ident; // Code of the airport its at.
208 std::string name; // Name transmitted in the broadcast.
211 // Rendering related stuff
212 bool _voice; // Flag - true if we are using voice
213 bool _playing; // Indicates a message in progress
214 bool _voiceOK; // Flag - true if at least one voice has loaded OK
217 SGSharedPtr<SGSampleGroup> _sgr; // default sample group;
220 bool freqClear; // Flag to indicate if the frequency is clear of ongoing dialog
221 bool receiving; // Flag to indicate we are receiving a transmission
224 double responseTime; // Time to take from end of request transmission to beginning of response
225 // The idea is that this will be slightly random.
227 bool respond; // Flag to indicate now is the time to respond - ie set following the count down of the response timer.
228 std::string responseID; // ID of the plane to respond to
229 bool runResponseCounter; // Flag to indicate the response counter should be run
230 double responseCounter; // counter to implement the above
231 // Derived classes only need monitor this flag, and use the response ID, as long as they call FGATC::Update(...)
232 bool _runReleaseCounter; // A timer for releasing the frequency after giving the message enough time to display
233 bool responseReqd; // Flag to indicate we should be responding to a request/report
235 double _releaseCounter;
237 bool _display; // Flag to indicate whether we should be outputting to the ATC display.
238 std::string pending_transmission; // derived classes set this string before calling Transmit(...)
241 // Transmission timing stuff.
245 int _callback_code; // A callback code to be notified and processed by the derived classes
246 // A value of zero indicates no callback required
247 bool _transmit; // we are to transmit
248 bool _transmitting; // we are transmitting
252 SGPropertyNode_ptr _volume;
253 SGPropertyNode_ptr _enabled;
254 SGPropertyNode_ptr _atc_external;
255 SGPropertyNode_ptr _internal;
258 std::istream& operator>> ( std::istream& fin, ATCData& a );
260 #endif // _FG_ATC_HXX