src/Instrumentation/tcas.hxx

   1 // tcas.hxx -- Traffic Alert and Collision Avoidance System (TCAS)
   2 //
   3 // Written by Thorsten Brehm, started December 2010.
   4 //
   5 // Copyright (C) 2010 Thorsten Brehm - brehmt (at) gmail com
   6 //
   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.
  11 //
  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.
  16 //
  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.
  20
  21 #ifndef __INSTRUMENTS_TCAS_HXX
  22 #define __INSTRUMENTS_TCAS_HXX
  23
  24 #include <assert.h>
  25
  26 #include <vector>
  27 #include <deque>
  28 #include <map>
  29
  30 #include <simgear/props/props.hxx>
  31 #include <simgear/structure/subsystem_mgr.hxx>
  32 #include <Sound/voiceplayer.hxx>
  33
  34 using std::vector;
  35 using std::deque;
  36 using std::map;
  37
  38 class SGSampleGroup;
  39
  40 #include <Main/globals.hxx>
  41
  42 #ifdef _MSC_VER
  43 #  pragma warning( push )
  44 #  pragma warning( disable: 4355 )
  45 #endif
  46
  47 ///////////////////////////////////////////////////////////////////////////////
  48 // TCAS  //////////////////////////////////////////////////////////////////////
  49 ///////////////////////////////////////////////////////////////////////////////
  50
  51 class TCAS : public SGSubsystem
  52 {
  53
  54     typedef enum
  55     {
  56         AdvisoryClear         = 0,                          /*< Clear of traffic */
  57         AdvisoryIntrusion     = 1,                          /*< Intrusion flag */
  58         AdvisoryClimb         = AdvisoryIntrusion|(1 << 1), /*< RA climb */
  59         AdvisoryDescend       = AdvisoryIntrusion|(1 << 2), /*< RA descend */
  60         AdvisoryAdjustVSpeed  = AdvisoryIntrusion|(1 << 3), /*< RA adjust vertical speed (TCAS II 7.0 only) */
  61         AdvisoryMaintVSpeed   = AdvisoryIntrusion|(1 << 4), /*< RA maintain vertical speed */
  62         AdvisoryMonitorVSpeed = AdvisoryIntrusion|(1 << 5), /*< RA monitor vertical speed */
  63         AdvisoryLevelOff      = AdvisoryIntrusion|(1 << 6)  /*< RA level off (TCAS II 7.1 only) */
  64     } EnumAdvisory;
  65
  66     typedef enum
  67     {
  68         OptionNone            = 0,        /*< no option modifier */
  69         OptionIncreaseClimb   = (1 << 0), /*< increase climb */
  70         OptionIncreaseDescend = (1 << 1), /*< increase descend */
  71         OptionCrossingClimb   = (1 << 2), /*< crossing climb */
  72         OptionCrossingDescent = (1 << 3)  /*< crossing descent */
  73     } EnumAdvisoryOption;
  74
  75     typedef enum
  76     {
  77         SwitchOff        = 0, /*< TCAS switched off */
  78         SwitchStandby    = 1, /*< TCAS standby (no TA/RA) */
  79         SwitchTaOnly     = 2, /*< TCAS in TA-only mode (no RA) */
  80         SwitchAuto       = 3  /*< TCAS in TA/RA mode */
  81     } EnumModeSwitch;
  82
  83     typedef enum
  84     {
  85         ThreatInvisible    = -1,/*< Traffic is invisible to TCAS (i.e. no transponder) */
  86         ThreatNone         = 0, /*< Traffic is visible but no threat. */
  87         ThreatProximity    = 1, /*< Proximity intruder traffic (no threat). */
  88         ThreatTA           = 2, /*< TA-level threat traffic. */
  89         ThreatRA           = 3  /*< RA-level threat traffic. */
  90     } EnumThreatLevel;
  91
  92     typedef struct
  93     {
  94       int  threatLevel;  /*< intruder threat level: 0=clear, 1=proximity,
  95                              2=intruder, 3=proximity intruder */
  96       int  RA;           /*< resolution advisory */
  97       int  RAOption;     /*< option flags for advisory */
  98     } ResolutionAdvisory;
  99
 100     typedef struct
 101     {
 102         float Tau;       /*< vertical/horizontal protection range in seconds */
 103         float DMOD;      /*< horizontal protection range in nm */
 104         float ALIM;      /*< vertical protection range in ft */
 105     } Thresholds;
 106
 107     typedef struct
 108     {
 109         double    maxAltitude; /*< max altitude for this sensitivity level */
 110         int        sl;         /*< sensitivity level */
 111         Thresholds TA;         /*< thresholds for TA-level threats */
 112         Thresholds RA;         /*< thresholds for RA-level threats */
 113     } SensitivityLevel;
 114
 115     typedef struct
 116     {
 117         string callsign;
 118         bool   verticalTA;
 119         bool   verticalRA;
 120         bool   horizontalTA;
 121         bool   horizontalRA;
 122         bool   isTracked;
 123         float  horizontalTau;
 124         float  verticalTau;
 125         float  relativeAltitudeFt;
 126         float  verticalFps;
 127         int    RASense;
 128     } ThreatInfo;
 129
 130     typedef struct
 131     {
 132         int    threatLevel;
 133         double TAtimestamp;
 134         double RAtimestamp;
 135     } TrackerTarget;
 136
 137     typedef map<string,TrackerTarget*> TrackerTargets;
 138
 139     typedef struct
 140     {
 141         double lat;
 142         double lon;
 143         float  altFt;
 144         float  heading;
 145         float  velocityKt;
 146         float  verticalFps;
 147     } LocalInfo; /*< info structure for local aircraft */
 148
 149     /////////////////////////////////////////////////////////////////////////////
 150     // TCAS::PropertiesHandler ///////////////////////////////////////////////
 151     /////////////////////////////////////////////////////////////////////////////
 152
 153     class PropertiesHandler : public FGVoicePlayer::PropertiesHandler
 154     {
 155       TCAS *tcas;
 156
 157     public:
 158       PropertiesHandler (TCAS *device) :
 159         FGVoicePlayer::PropertiesHandler(), tcas(device) {}
 160
 161       PropertiesHandler (void) : FGVoicePlayer::PropertiesHandler() {}
 162     };
 163
 164     /////////////////////////////////////////////////////////////////////////////
 165     // TCAS::VoicePlayer ////////////////////////////////////////////////////////
 166     /////////////////////////////////////////////////////////////////////////////
 167
 168     class VoicePlayer :
 169         public FGVoicePlayer
 170     {
 171     public:
 172         VoicePlayer (TCAS* tcas) :
 173           FGVoicePlayer(&tcas->properties_handler, "tcas") {}
 174
 175         ~VoicePlayer (void) {}
 176
 177         void init    (void);
 178
 179         struct
 180         {
 181           Voice* pTrafficTraffic;
 182           Voice* pClimb;
 183           Voice* pClimbNow;
 184           Voice* pClimbCrossing;
 185           Voice* pClimbIncrease;
 186           Voice* pDescend;
 187           Voice* pDescendNow;
 188           Voice* pDescendCrossing;
 189           Voice* pDescendIncrease;
 190           Voice* pClear;
 191           Voice* pAdjustVSpeed;
 192           Voice* pMaintVSpeed;
 193           Voice* pMonitorVSpeed;
 194           Voice* pLevelOff;
 195           Voice* pTestOk;
 196           Voice* pTestFail;
 197         } Voices;
 198     private:
 199         SGPropertyNode_ptr nodeSoundFilePrefix;
 200     };
 201
 202     /////////////////////////////////////////////////////////////////////////////
 203     // TCAS::Annunciator ////////////////////////////////////////////////////////
 204     /////////////////////////////////////////////////////////////////////////////
 205
 206     class Annunciator
 207     {
 208     public:
 209         Annunciator    (TCAS* tcas);
 210         ~Annunciator   (void) {}
 211         void bind      (SGPropertyNode* node);
 212         void init      (void);
 213         void update    (void);
 214
 215         void trigger   (const ResolutionAdvisory& newAdvisory, bool revertedRA);
 216         void test      (bool testOk);
 217         void clear     (void);
 218         bool isPlaying (void) { return voicePlayer.is_playing();}
 219
 220     private:
 221         TCAS* tcas;
 222         ResolutionAdvisory previous;
 223         FGVoicePlayer::Voice* pLastVoice;
 224         VoicePlayer voicePlayer;
 225         SGPropertyNode_ptr nodeGpwsAlertOn;
 226     };
 227
 228     /////////////////////////////////////////////////////////////////////////////
 229     // TCAS::AdvisoryCoordinator ////////////////////////////////////////////////
 230     /////////////////////////////////////////////////////////////////////////////
 231
 232     class AdvisoryCoordinator
 233     {
 234     public:
 235         AdvisoryCoordinator  (TCAS* _tcas);
 236         ~AdvisoryCoordinator (void) {}
 237
 238         void bind            (SGPropertyNode* node);
 239         void init            (void);
 240         void update          (int mode);
 241
 242         void clear           (void);
 243         void add             (const ResolutionAdvisory& newAdvisory);
 244
 245     private:
 246         TCAS* tcas;
 247         double lastTATime;
 248         ResolutionAdvisory current;
 249         ResolutionAdvisory previous;
 250         SGPropertyNode_ptr nodeTAWarning;
 251     };
 252
 253     /////////////////////////////////////////////////////////////////////////////
 254     // TCAS::Tracker ////////////////////////////////////////////////////////////
 255     /////////////////////////////////////////////////////////////////////////////
 256
 257     class Tracker
 258     {
 259     public:
 260         Tracker  (TCAS* _tcas);
 261         ~Tracker (void) {}
 262
 263         void update          (void);
 264
 265         void add             (const string callsign, int detectedLevel);
 266         bool active          (void) { return haveTargets;}
 267         bool newTraffic      (void) { return newTargets;}
 268         bool isTracked       (string callsign) { if (!haveTargets) return false;else return _isTracked(callsign);}
 269         bool _isTracked      (string callsign);
 270         int  getThreatLevel  (string callsign);
 271
 272     private:
 273         TCAS*  tcas;
 274         double currentTime;
 275         bool   haveTargets;
 276         bool   newTargets;
 277         TrackerTargets targets;
 278     };
 279
 280     /////////////////////////////////////////////////////////////////////////////
 281     // TCAS::AdvisoryGenerator //////////////////////////////////////////////////
 282     /////////////////////////////////////////////////////////////////////////////
 283
 284     class AdvisoryGenerator
 285     {
 286     public:
 287         AdvisoryGenerator        (TCAS* _tcas);
 288         ~AdvisoryGenerator       (void) {}
 289
 290         void init                (const LocalInfo* _pSelf, ThreatInfo* _pCurrentThreat);
 291
 292         void setAlarmThresholds  (const SensitivityLevel* _pAlarmThresholds);
 293
 294         int   resolution         (int mode, int threatLevel, float distanceNm,
 295                                   float altFt, float heading, float velocityKt);
 296
 297     private:
 298         float verticalSeparation (float newVerticalFps);
 299         void  determineRAsense   (int& RASense, bool& isCrossing);
 300
 301     private:
 302         TCAS*             tcas;
 303         const LocalInfo*  pSelf;          /*< info structure for local aircraft */
 304         ThreatInfo* pCurrentThreat; /*< info structure on current intruder/threat */
 305         const SensitivityLevel* pAlarmThresholds;
 306     };
 307
 308     /////////////////////////////////////////////////////////////////////////////
 309     // TCAS::ThreatDetector /////////////////////////////////////////////////////
 310     /////////////////////////////////////////////////////////////////////////////
 311
 312     class ThreatDetector
 313     {
 314     public:
 315         ThreatDetector            (TCAS* _tcas);
 316         ~ThreatDetector           (void) {}
 317
 318         void  init                (void);
 319         void  update              (void);
 320
 321         bool  checkTransponder    (const SGPropertyNode* pModel, float velocityKt);
 322         int   checkThreat         (int mode, const SGPropertyNode* pModel);
 323         void  checkVerticalThreat (void);
 324         void  horizontalThreat    (float bearing, float distanceNm, float heading,
 325                                    float velocityKt);
 326
 327         void  setAlt              (float altFt) { self.altFt = altFt;}
 328         float getAlt              (void)        { return self.altFt;}
 329         float getVelocityKt       (void)        { return self.velocityKt;}
 330         int   getRASense          (void)        { return currentThreat.RASense;}
 331
 332     private:
 333         void  unitTest            (void);
 334
 335     private:
 336         static const SensitivityLevel sensitivityLevels[];
 337
 338         TCAS*              tcas;
 339         int                checkCount;
 340
 341         SGPropertyNode_ptr nodeLat;
 342         SGPropertyNode_ptr nodeLon;
 343         SGPropertyNode_ptr nodeAlt;
 344         SGPropertyNode_ptr nodeHeading;
 345         SGPropertyNode_ptr nodeVelocity;
 346         SGPropertyNode_ptr nodeVerticalFps;
 347
 348         LocalInfo          self;          /*< info structure for local aircraft */
 349         ThreatInfo         currentThreat; /*< info structure on current intruder/threat */
 350         const SensitivityLevel* pAlarmThresholds;
 351     };
 352
 353 private:
 354     string              name;
 355     int                 num;
 356     double              nextUpdateTime;
 357     int                 selfTestStep;
 358
 359     SGPropertyNode_ptr  nodeModeSwitch;
 360     SGPropertyNode_ptr  nodeServiceable;
 361     SGPropertyNode_ptr  nodeSelfTest;
 362     SGPropertyNode_ptr  nodeDebugTrigger;
 363     SGPropertyNode_ptr  nodeDebugRA;
 364     SGPropertyNode_ptr  nodeDebugThreat;
 365
 366     PropertiesHandler   properties_handler;
 367     ThreatDetector      threatDetector;
 368     Tracker             tracker;
 369     AdvisoryCoordinator advisoryCoordinator;
 370     AdvisoryGenerator   advisoryGenerator;
 371     Annunciator         annunciator;
 372
 373 private:
 374     void selfTest       (void);
 375
 376 public:
 377     TCAS (SGPropertyNode* node);
 378
 379     virtual void bind   (void);
 380     virtual void unbind (void);
 381     virtual void init   (void);
 382     virtual void update (double dt);
 383 };
 384
 385 #ifdef _MSC_VER
 386 #  pragma warning( pop )
 387 #endif
 388
 389 #endif // __INSTRUMENTS_TCAS_HXX