iffState.h

Go to the documentation of this file.

/*********************************************************************************
** Copyright (c) 2014 MAK Technologies, Inc.
** All rights reserved.
*********************************************************************************/

#pragma once

#include "managedInterface/message.h"

#include <string>
#include <matrix/vlVector.h>

#ifndef IFF_MODE_CODE_SIZE
#define IFF_MODE_CODE_SIZE 3
#endif

class MANAGEDINTERFACE_DLL IffStateMessage : public DtMessage
{
public:
   enum CapabilityReport {CapabilityReport_NoCapability            =   0, CapabilityReport_CommAB7Ground           =   4, CapabilityReport_CommAB7Airborne         =   5, CapabilityReport_CommAB7GroundAirborne   =   6, CapabilityReport_DR1FS2345AirborneGround =   7, CapabilityReport_NoStatement             = 255};
   enum ModeSLevelsPresent {ModeSLevelsPresent_Level1           = 1, ModeSLevelsPresent_Level2Elementary = 2, ModeSLevelsPresent_Level2Enhanced   = 3, ModeSLevelsPresent_Level3           = 4, ModeSLevelsPresent_Level4           = 5};
   enum SystemName {SystemName_OtherSysName           = 0, SystemName_MarkX                  = 1, SystemName_MarkXII                = 2, SystemName_ATCRBS                 = 3, SystemName_Soviet                 = 4, SystemName_ModeS                  = 5, SystemName_MarkX_XII_ATCRBS       = 6, SystemName_MarkX_XII_ATCRBS_ModeS = 7};
   enum SystemType {SystemType_OtherSysType = 0, SystemType_Transponder = 1, SystemType_Interrogator = 2, SystemType_SovietTransponder = 3, SystemType_SovietInterrogator = 4};
   enum AircraftPresentDomain {AircraftPresentDomain_NoStatement     = 0, AircraftPresentDomain_Airborne        = 1, AircraftPresentDomain_OnGroundSurface = 2};
   enum OperationalParameter1 {OperationalParameter1_OtherOperationalParameter1 = 0};
   enum DAPSource {DAPSource_IASBit             = 0, DAPSource_MachNumberBit      = 1, DAPSource_GroundSpeedBit     = 2, DAPSource_MagneticHeadingBit = 3, DAPSource_TrackAngleRateBit  = 4, DAPSource_TrueTrackAngleBit  = 5, DAPSource_TrueAirspeedBit    = 6, DAPSource_VerticalRateBit    = 7};
   enum AircraftIdentificationType {AircraftIdentificationType_NoStatement  = 0, AircraftIdentificationType_FlightNumber = 1, AircraftIdentificationType_TailNumber   = 2};
   enum DataCategory {DataCategory_NoStatement      = 0, DataCategory_FunctionalData   = 1, DataCategory_DataLinkMessages = 2};
   enum AltParm4 {AltParm4_Other      = 0, AltParm4_Valid      = 1, AltParm4_Invalid    = 2, AltParm4_NoResponse = 3};
   enum NavigationSource {NavigationSource_NoStatement = 0, NavigationSource_GPS         = 1, NavigationSource_INS         = 2, NavigationSource_INSGPS      = 3};
   enum OperationalParameter2 {OperationalParameter2_OtherOperationalParameter2 = 0};
   enum DtModeOrParameterKind {Enabled = 0, IsDamaged = 1, IsMalfunctioning = 2, IsOn = 3};


   struct SimulationAddress
   {
   unsigned short mySiteId;
   unsigned short myApplicationId;

        
      int size()
      {
         int size=0;
   size+=sizeof(unsigned short);
   size+=sizeof(unsigned short);

         return size;
      }

      void serialize(DtStreamWriter& writer)
      {
   writer.writeUInt16(mySiteId);
   writer.writeUInt16(myApplicationId);

      }
        
      void deserialize(DtStreamReader& reader)
      {
   mySiteId=reader.readUInt16();
   myApplicationId=reader.readUInt16();

      }
   };




  IffStateMessage();
  virtual ~IffStateMessage();

   virtual std::string getEntityIdentifier();
   virtual void setEntityIdentifier(std::string val);

   virtual std::string getHostEntityIdentifier();
   virtual void setHostEntityIdentifier(std::string val);

   virtual DtVector32 getRelativePosition();
   virtual void setRelativePosition(DtVector32 val);

   virtual SystemType getSystemType();
   virtual void setSystemType(SystemType val);

   virtual SystemName getSystemName();
   virtual void setSystemName(SystemName val);

   virtual unsigned char getSystemMode();
   virtual void setSystemMode(unsigned char val);

   virtual std::string getEventId();
   virtual void setEventId(std::string val);

   virtual AltParm4 getAlternateMode4();
   virtual void setAlternateMode4(AltParm4 val);

   virtual bool getSystemIsOn();
   virtual void setSystemIsOn(bool val);

   virtual bool getSystemIsOperational();
   virtual void setSystemIsOperational(bool val);

   virtual bool getSimulationMode();
   virtual void setSimulationMode(bool val);

   virtual bool getInteractiveCapable();
   virtual void setInteractiveCapable(bool val);

   virtual void setModeOrParameterVal(char type, int status, bool onOff);
   virtual void setModeOrParameterVal(int type, int status, bool onOff);
   virtual bool getModeOrParameterVal(char type, int status) const;
   virtual bool getModeOrParameterVal(int type, int status) const;

   virtual void setModeEnabled(int modeType, bool onOff);
   virtual bool modeEnabled(int modeType) const;
   virtual void setModeEnabled(char modeType, bool onOff);
   virtual bool modeEnabled(char modeType) const;

   virtual void setModeIsMalfunctioning(int modeType, bool onOff);
   virtual bool modeIsMalfunctioning(int modeType) const;
   virtual void setModeIsMalfunctioning(char modeType, bool onOff);
   virtual bool modeIsMalfunctioning(char modeType) const;

   virtual void setModeIsDamaged(int modeType, bool onOff);
   virtual bool modeIsDamaged(int modeType) const;
   virtual void setModeIsDamaged(char modeType, bool onOff);
   virtual bool modeIsDamaged(char modeType) const;

   virtual void setModeIsOn(int modeType, bool onOff);
   virtual bool modeIsOn(int modeType) const;
   virtual void setModeIsOn(char modeType, bool onOff);
   virtual bool modeIsOn(char modeType) const;

   virtual unsigned short getMode4PseudoCrypto();
   virtual void setMode4PseudoCrypto(unsigned short val);

   virtual bool getMode4PseudoCryptoAvailable();
   virtual void setMode4PseudoCryptoAvailable(bool val);

   virtual bool getModeSIsTcasI();
   virtual void setModeSIsTcasI(bool val);

   virtual unsigned short modeCode(int modeCodeNum);
   virtual void setModeCode(int modeCodeNum, unsigned short val);

   virtual bool getEmergencyOn();
   virtual void setEmergencyOn(bool val);

   virtual bool getIdentSquawkFlashOn();
   virtual void setIdentSquawkFlashOn(bool val);

   virtual bool getUnmannedAircraftOn();
   virtual void setUnmannedAircraftOn(bool val);

   virtual bool getModeCAltitudeAvailable();
   virtual void setModeCAltitudeAvailable(bool val);

   virtual short getModeCAltitude();
   virtual void setModeCAltitude(short val);

   virtual bool getStiOn();
   virtual void setStiOn(bool val);

   virtual unsigned char getCode();
   virtual void setCode(unsigned char val);

   virtual bool getPowerReduction();
   virtual void setPowerReduction(bool val);

   virtual bool getIsDamaged();
   virtual void setIsDamaged(bool val);

   virtual bool getIsMalfunctioning();
   virtual void setIsMalfunctioning(bool val);

   virtual bool getIsOn();
   virtual void setIsOn(bool val);

   virtual bool getRadarEnhancement();
   virtual void setRadarEnhancement(bool val);

   virtual bool getLayer2DataAvailable();
   virtual void setLayer2DataAvailable(bool val);

   virtual bool getLayer3DataAvailable();
   virtual void setLayer3DataAvailable(bool val);

   virtual bool getLayer4DataAvailable();
   virtual void setLayer4DataAvailable(bool val);

   virtual bool getLayer5DataAvailable();
   virtual void setLayer5DataAvailable(bool val);

   virtual unsigned int getLayer2SpecificInfo();
   virtual void setLayer2SpecificInfo(unsigned int val);

   virtual unsigned int getLayer3SpecificInfo();
   virtual void setLayer3SpecificInfo(unsigned int val);

   virtual unsigned int getLayer4SpecificInfo();
   virtual void setLayer4SpecificInfo(unsigned int val);

   virtual unsigned int getLayer5SpecificInfo();
   virtual void setLayer5SpecificInfo(unsigned int val);

   virtual float getAzimuthCenter();
   virtual void setAzimuthCenter(float val);

   virtual float getAzimuthSweep();
   virtual void setAzimuthSweep(float val);

   virtual float getElevationCenter();
   virtual void setElevationCenter(float val);

   virtual float getElevationSweep();
   virtual void setElevationSweep(float val);

   virtual float getSweepSync();
   virtual void setSweepSync(float val);

   virtual OperationalParameter1 getSecondaryOperationalDataParameter1();
   virtual void setSecondaryOperationalDataParameter1(OperationalParameter1 val);

   virtual OperationalParameter2 getSecondaryOperationalDataParameter2();
   virtual void setSecondaryOperationalDataParameter2(OperationalParameter2 val);

   virtual unsigned char getSystemDesignator();
   virtual void setSystemDesignator(unsigned char val);

   virtual unsigned char getSystemSpecificData();
   virtual void setSystemSpecificData(unsigned char val);

   virtual SimulationAddress getReportingSimulation();
   virtual void setReportingSimulation(SimulationAddress val);

   virtual unsigned int getMessageFormatsPresent();
   virtual void setMessageFormatsPresent(unsigned int val);

   virtual unsigned char getMode5InterrogatorStatus();
   virtual void setMode5InterrogatorStatus(unsigned char val);

   virtual std::string getInterrogatedEntityID();
   virtual void setInterrogatedEntityID(std::string val);

   virtual unsigned short getMode5TransponderStatus();
   virtual void setMode5TransponderStatus(unsigned short val);

   virtual unsigned short getPin();
   virtual void setPin(unsigned short val);

   virtual unsigned short getEnhancedMode1();
   virtual void setEnhancedMode1(unsigned short val);

   virtual unsigned int getEnhancedMode1Code1();
   virtual void setEnhancedMode1Code1(unsigned int val);

   virtual unsigned int getEnhancedMode1Code2();
   virtual void setEnhancedMode1Code2(unsigned int val);

   virtual unsigned int getEnhancedMode1Code3();
   virtual void setEnhancedMode1Code3(unsigned int val);

   virtual unsigned int getEnhancedMode1Code4();
   virtual void setEnhancedMode1Code4(unsigned int val);

   virtual bool getEnhancedMode1OnOff();
   virtual void setEnhancedMode1OnOff(bool val);

   virtual bool getEnhancedMode1DamageStatus();
   virtual void setEnhancedMode1DamageStatus(bool val);

   virtual bool getEnhancedMode1MalfunctionStatus();
   virtual void setEnhancedMode1MalfunctionStatus(bool val);

   virtual unsigned short getNationalOrigin();
   virtual void setNationalOrigin(unsigned short val);

   virtual unsigned char getSupplementalData();
   virtual void setSupplementalData(unsigned char val);

   virtual NavigationSource getNavigationSource();
   virtual void setNavigationSource(NavigationSource val);

   virtual unsigned char getFigureOfMerit();
   virtual void setFigureOfMerit(unsigned char val);

   virtual ModeSLevelsPresent getModeSLevelsPresent();
   virtual void setModeSLevelsPresent(ModeSLevelsPresent val);

   virtual unsigned char getModeSInterrogatorStatus();
   virtual void setModeSInterrogatorStatus(unsigned char val);

   virtual unsigned short getModeSTransponderStatus();
   virtual void setModeSTransponderStatus(unsigned short val);

   virtual AircraftPresentDomain getAircraftPresentDomain();
   virtual void setAircraftPresentDomain(AircraftPresentDomain val);

   virtual unsigned char getAircraftID();
   virtual void setAircraftID(unsigned char val);

   virtual unsigned int getAircraftAddress();
   virtual void setAircraftAddress(unsigned int val);

   virtual AircraftIdentificationType getAircraftIDType();
   virtual void setAircraftIDType(AircraftIdentificationType val);

   virtual DAPSource getDapSource();
   virtual void setDapSource(DAPSource val);

   virtual unsigned short getModeSAltitude();
   virtual void setModeSAltitude(unsigned short val);

   virtual CapabilityReport getCapabilityReport();
   virtual void setCapabilityReport(CapabilityReport val);

   virtual unsigned char getAvailableLayers();
   virtual void setAvailableLayers(unsigned char val);

   virtual DataCategory getDataCategory();
   virtual void setDataCategory(DataCategory val);



  virtual int messageSize();
  
   static DtMessage* decode(unsigned char* buffer, int length);
   static std::string theMessageName();

protected:
   static std::string theFullName;

   std::string myEntityIdentifier;
   std::string myHostEntityIdentifier;
   DtVector32 myRelativePosition;
   SystemType mySystemType;
   SystemName mySystemName;
   unsigned char mySystemMode;
   std::string myEventId;
   AltParm4 myAlternateMode4;
   bool mySystemIsOn;
   bool mySystemIsOperational;
   bool mySimulationMode;
   bool myInteractiveCapable;
   unsigned short myMode4PseudoCrypto;
   bool myMode4PseudoCryptoAvailable;
   bool myModeSIsTcasI;
   bool myEmergencyOn;
   bool myIdentSquawkFlashOn;
   bool myUnmannedAircraftOn;
   bool myModeCAltitudeAvailable;
   short myModeCAltitude;
   bool myStiOn;
   unsigned char myCode;
   bool myPowerReduction;
   bool myIsDamaged;
   bool myIsMalfunctioning;
   bool myIsOn;
   bool myRadarEnhancement;
   bool myLayer2DataAvailable;
   bool myLayer3DataAvailable;
   bool myLayer4DataAvailable;
   bool myLayer5DataAvailable;
   unsigned int myLayer2SpecificInfo;
   unsigned int myLayer3SpecificInfo;
   unsigned int myLayer4SpecificInfo;
   unsigned int myLayer5SpecificInfo;
   float myAzimuthCenter;
   float myAzimuthSweep;
   float myElevationCenter;
   float myElevationSweep;
   float mySweepSync;
   OperationalParameter1 mySecondaryOperationalDataParameter1;
   OperationalParameter2 mySecondaryOperationalDataParameter2;
   unsigned char mySystemDesignator;
   unsigned char mySystemSpecificData;
   SimulationAddress myReportingSimulation;
   unsigned int myMessageFormatsPresent;
   unsigned char myMode5InterrogatorStatus;
   std::string myInterrogatedEntityID;
   unsigned short myMode5TransponderStatus;
   unsigned short myPin;
   unsigned short myEnhancedMode1;
   unsigned int myEnhancedMode1Code1;
   unsigned int myEnhancedMode1Code2;
   unsigned int myEnhancedMode1Code3;
   unsigned int myEnhancedMode1Code4;
   bool myEnhancedMode1OnOff;
   bool myEnhancedMode1DamageStatus;
   bool myEnhancedMode1MalfunctionStatus;
   unsigned short myNationalOrigin;
   unsigned char mySupplementalData;
   NavigationSource myNavigationSource;
   unsigned char myFigureOfMerit;
   ModeSLevelsPresent myModeSLevelsPresent;
   unsigned char myModeSInterrogatorStatus;
   unsigned short myModeSTransponderStatus;
   AircraftPresentDomain myAircraftPresentDomain;
   unsigned char myAircraftID;
   unsigned int myAircraftAddress;
   AircraftIdentificationType myAircraftIDType;
   DAPSource myDapSource;
   unsigned short myModeSAltitude;
   CapabilityReport myCapabilityReport;
   unsigned char myAvailableLayers;
   DataCategory myDataCategory;

   bool myModeParameterStatusValues[6][4];

   unsigned short myModeCode[IFF_MODE_CODE_SIZE];

   virtual void serialize(DtStreamWriter& writer);
   virtual void deserialize(DtStreamReader& reader);
};