1 // tcas.hxx -- Traffic Alert and Collision Avoidance System (TCAS)
3 // Written by Thorsten Brehm, started December 2010.
5 // Copyright (C) 2010 Thorsten Brehm - brehmt (at) gmail com
7 // This program is free software; you can redistribute it and/or
8 // modify it under the terms of the GNU General Public License as
9 // published by the Free Software Foundation; either version 2 of the
10 // License, or (at your option) any later version.
12 // This program is distributed in the hope that it will be useful, but
13 // WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 // General Public License for more details.
17 // You should have received a copy of the GNU General Public License
18 // along with this program; if not, write to the Free Software
19 // Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 #ifndef __INSTRUMENTS_TCAS_HXX
22 #define __INSTRUMENTS_TCAS_HXX
30 #include <simgear/props/props.hxx>
31 #include <simgear/sound/sample_openal.hxx>
32 #include <simgear/structure/subsystem_mgr.hxx>
33 #include "mk_viii.hxx" // FGVoicePlayer only
41 #include <Main/globals.hxx>
44 # pragma warning( push )
45 # pragma warning( disable: 4355 )
48 ///////////////////////////////////////////////////////////////////////////////
49 // TCAS //////////////////////////////////////////////////////////////////////
50 ///////////////////////////////////////////////////////////////////////////////
52 class TCAS : public SGSubsystem
57 AdvisoryClear = 0, /*< Clear of traffic */
58 AdvisoryIntrusion = 1, /*< Intrusion flag */
59 AdvisoryClimb = AdvisoryIntrusion|(1 << 1), /*< RA climb */
60 AdvisoryDescend = AdvisoryIntrusion|(1 << 2), /*< RA descend */
61 AdvisoryAdjustVSpeed = AdvisoryIntrusion|(1 << 3), /*< RA adjust vertical speed (TCAS II 7.0 only) */
62 AdvisoryMaintVSpeed = AdvisoryIntrusion|(1 << 4), /*< RA maintain vertical speed */
63 AdvisoryMonitorVSpeed = AdvisoryIntrusion|(1 << 5), /*< RA monitor vertical speed */
64 AdvisoryLevelOff = AdvisoryIntrusion|(1 << 6) /*< RA level off (TCAS II 7.1 only) */
69 OptionNone = 0, /*< no option modifier */
70 OptionIncreaseClimb = (1 << 0), /*< increase climb */
71 OptionIncreaseDescend = (1 << 1), /*< increase descend */
72 OptionCrossingClimb = (1 << 2), /*< crossing climb */
73 OptionCrossingDescent = (1 << 3) /*< crossing descent */
78 SwitchOff = 0, /*< TCAS switched off */
79 SwitchStandby = 1, /*< TCAS standby (no TA/RA) */
80 SwitchTaOnly = 2, /*< TCAS in TA-only mode (no RA) */
81 SwitchAuto = 3 /*< TCAS in TA/RA mode */
86 ThreatInvisible = -1,/*< Traffic is invisible to TCAS (i.e. no transponder) */
87 ThreatNone = 0, /*< Traffic is visible but no threat. */
88 ThreatProximity = 1, /*< Proximity intruder traffic (no threat). */
89 ThreatTA = 2, /*< TA-level threat traffic. */
90 ThreatRA = 3 /*< RA-level threat traffic. */
95 int threatLevel; /*< intruder threat level: 0=clear, 1=proximity,
96 2=intruder, 3=proximity intruder */
97 int RA; /*< resolution advisory */
98 int RAOption; /*< option flags for advisory */
103 float Tau; /*< vertical/horizontal protection range in seconds */
104 float DMOD; /*< horizontal protection range in nm */
105 float ALIM; /*< vertical protection range in ft */
110 double maxAltitude; /*< max altitude for this sensitivity level */
111 int sl; /*< sensitivity level */
112 Thresholds TA; /*< thresholds for TA-level threats */
113 Thresholds RA; /*< thresholds for RA-level threats */
126 float relativeAltitudeFt;
138 typedef map<string,TrackerTarget*> TrackerTargets;
148 } LocalInfo; /*< info structure for local aircraft */
150 /////////////////////////////////////////////////////////////////////////////
151 // TCAS::PropertiesHandler ///////////////////////////////////////////////
152 /////////////////////////////////////////////////////////////////////////////
154 class PropertiesHandler : public FGVoicePlayer::PropertiesHandler
159 PropertiesHandler (TCAS *device) :
160 FGVoicePlayer::PropertiesHandler(), tcas(device) {}
162 PropertiesHandler (void) : FGVoicePlayer::PropertiesHandler() {}
165 /////////////////////////////////////////////////////////////////////////////
166 // TCAS::VoicePlayer ////////////////////////////////////////////////////////
167 /////////////////////////////////////////////////////////////////////////////
173 VoicePlayer (TCAS* tcas) :
174 FGVoicePlayer(&tcas->properties_handler, "tcas") {}
176 ~VoicePlayer (void) {}
182 Voice* pTrafficTraffic;
185 Voice* pClimbCrossing;
186 Voice* pClimbIncrease;
189 Voice* pDescendCrossing;
190 Voice* pDescendIncrease;
192 Voice* pAdjustVSpeed;
194 Voice* pMonitorVSpeed;
200 SGPropertyNode_ptr nodeSoundFilePrefix;
203 /////////////////////////////////////////////////////////////////////////////
204 // TCAS::Annunciator ////////////////////////////////////////////////////////
205 /////////////////////////////////////////////////////////////////////////////
210 Annunciator (TCAS* tcas);
211 ~Annunciator (void) {}
212 void bind (SGPropertyNode* node);
216 void trigger (const ResolutionAdvisory& newAdvisory, bool revertedRA);
217 void test (bool testOk);
219 bool isPlaying (void) { return voicePlayer.is_playing();}
223 ResolutionAdvisory previous;
224 FGVoicePlayer::Voice* pLastVoice;
225 VoicePlayer voicePlayer;
226 SGPropertyNode_ptr nodeGpwsAlertOn;
229 /////////////////////////////////////////////////////////////////////////////
230 // TCAS::AdvisoryCoordinator ////////////////////////////////////////////////
231 /////////////////////////////////////////////////////////////////////////////
233 class AdvisoryCoordinator
236 AdvisoryCoordinator (TCAS* _tcas);
237 ~AdvisoryCoordinator (void) {}
239 void bind (SGPropertyNode* node);
241 void update (int mode);
244 void add (const ResolutionAdvisory& newAdvisory);
249 ResolutionAdvisory current;
250 ResolutionAdvisory previous;
251 SGPropertyNode_ptr nodeTAWarning;
254 /////////////////////////////////////////////////////////////////////////////
255 // TCAS::Tracker ////////////////////////////////////////////////////////////
256 /////////////////////////////////////////////////////////////////////////////
261 Tracker (TCAS* _tcas);
266 void add (const string callsign, int detectedLevel);
267 bool active (void) { return haveTargets;}
268 bool newTraffic (void) { return newTargets;}
269 bool isTracked (string callsign) { if (!haveTargets) return false;else return _isTracked(callsign);}
270 bool _isTracked (string callsign);
271 int getThreatLevel (string callsign);
278 TrackerTargets targets;
281 /////////////////////////////////////////////////////////////////////////////
282 // TCAS::AdvisoryGenerator //////////////////////////////////////////////////
283 /////////////////////////////////////////////////////////////////////////////
285 class AdvisoryGenerator
288 AdvisoryGenerator (TCAS* _tcas);
289 ~AdvisoryGenerator (void) {}
291 void init (const LocalInfo* _pSelf, ThreatInfo* _pCurrentThreat);
293 void setAlarmThresholds (const SensitivityLevel* _pAlarmThresholds);
295 int resolution (int mode, int threatLevel, float distanceNm,
296 float altFt, float heading, float velocityKt);
299 float verticalSeparation (float newVerticalFps);
300 void determineRAsense (int& RASense, bool& isCrossing);
304 const LocalInfo* pSelf; /*< info structure for local aircraft */
305 ThreatInfo* pCurrentThreat; /*< info structure on current intruder/threat */
306 const SensitivityLevel* pAlarmThresholds;
309 /////////////////////////////////////////////////////////////////////////////
310 // TCAS::ThreatDetector /////////////////////////////////////////////////////
311 /////////////////////////////////////////////////////////////////////////////
316 ThreatDetector (TCAS* _tcas);
317 ~ThreatDetector (void) {}
322 bool checkTransponder (const SGPropertyNode* pModel, float velocityKt);
323 int checkThreat (int mode, const SGPropertyNode* pModel);
324 void checkVerticalThreat (void);
325 void horizontalThreat (float bearing, float distanceNm, float heading,
328 void setAlt (float altFt) { self.altFt = altFt;}
329 float getAlt (void) { return self.altFt;}
330 float getVelocityKt (void) { return self.velocityKt;}
331 int getRASense (void) { return currentThreat.RASense;}
334 void unitTest (void);
337 static const SensitivityLevel sensitivityLevels[];
342 SGPropertyNode_ptr nodeLat;
343 SGPropertyNode_ptr nodeLon;
344 SGPropertyNode_ptr nodeAlt;
345 SGPropertyNode_ptr nodeHeading;
346 SGPropertyNode_ptr nodeVelocity;
347 SGPropertyNode_ptr nodeVerticalFps;
349 LocalInfo self; /*< info structure for local aircraft */
350 ThreatInfo currentThreat; /*< info structure on current intruder/threat */
351 const SensitivityLevel* pAlarmThresholds;
357 double nextUpdateTime;
360 SGPropertyNode_ptr nodeModeSwitch;
361 SGPropertyNode_ptr nodeServiceable;
362 SGPropertyNode_ptr nodeSelfTest;
363 SGPropertyNode_ptr nodeDebugTrigger;
364 SGPropertyNode_ptr nodeDebugRA;
365 SGPropertyNode_ptr nodeDebugThreat;
367 PropertiesHandler properties_handler;
368 ThreatDetector threatDetector;
370 AdvisoryCoordinator advisoryCoordinator;
371 AdvisoryGenerator advisoryGenerator;
372 Annunciator annunciator;
375 void selfTest (void);
378 TCAS (SGPropertyNode* node);
380 virtual void bind (void);
381 virtual void unbind (void);
382 virtual void init (void);
383 virtual void update (double dt);
387 # pragma warning( pop )
390 #endif // __INSTRUMENTS_TCAS_HXX