iffStateRepository.h

Go to the documentation of this file.

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


#pragma once

#include <vl/embeddedSystemRepository.h>
#include <vl/iffAtcNavaidsParameter.h>
#include "vl/iffAtcNavaidsVariableRecord.h"
#include <vl/hostStructs.h>
#include <vl/eventId.h>
#include <vlutil/vlNetTypes.h>
#include <string.h>
#include "iffDatatypes.h"

class DT_DLL_VL DtIFFDataStateRepository;
class DT_DLL_VL DtMode1StateRepository;
class DT_DLL_VL DtMode2StateRepository;
class DT_DLL_VL DtMode3AStateRepository;
class DT_DLL_VL DtMode3CStateRepository;
class DT_DLL_VL DtMode4StateRepository;
class DT_DLL_VL DtMode5StateRepository;
class DT_DLL_VL DtModeSStateRepository;
class DT_DLL_VL DtTCASDataStateRepository;
class DT_DLL_VL DtSovietStateRepository;
class DT_DLL_VL DtRRBStateRepository;

#ifndef DtIFF_MODE_CODE_SIZE
#define DtIFF_MODE_CODE_SIZE 3
#endif

class DT_DLL_VL DtIffStateRepository : public DtEmbeddedSystemRepository
{

public:

   DtIffStateRepository();

   virtual ~DtIffStateRepository();

   DtIffStateRepository(const DtIffStateRepository& orig);

   DtIffStateRepository& operator=(const DtIffStateRepository& orig);

   virtual DtStateRepository* clone(bool copy = false) const;

   virtual void printData() const;

   virtual void printDataToStream(std::ostream& stream) const;

   // Factories for dependant related IFFDatat state repos.
   static DtMode1StateRepository* (*theMode1StateRepositoryCreator)();
   static DtMode2StateRepository* (*theMode2StateRepositoryCreator)();
   static DtMode3AStateRepository* (*theMode3AStateRepositoryCreator)();
   static DtMode3CStateRepository* (*theMode3CStateRepositoryCreator)();
   static DtMode4StateRepository* (*theMode4StateRepositoryCreator)();
   static DtMode5StateRepository* (*theMode5StateRepositoryCreator)();
   static DtModeSStateRepository* (*theModeSStateRepositoryCreator)();
   static DtTCASDataStateRepository* (*theTCASDataStateRepositoryCreator)();
   static DtSovietStateRepository* (*theSovietStateRepositoryCreator)();
   static DtRRBStateRepository* (*theRRBStateRepositoryCreator)();


/************** IFF SYSTEM ATTRIBUTES *****************/

   virtual void setSystemType(DtIffAtcNavaidsSysType type );
   virtual DtIffAtcNavaidsSysType systemType() const;

   virtual void setSystemName(DtIffAtcNavaidsSysName name );
   virtual DtIffAtcNavaidsSysName systemName() const;

   virtual void setSystemDesignator(DtU8 designator);
   virtual DtU8 systemDesignator() const;

   virtual void setInteractiveModeIsActive(bool isActive);
   virtual bool interactiveModeIsActive() const;

   virtual void setEventId(const DtEventId &eventId);
   virtual const DtEventId& eventId() const;

   virtual void setSystemIsOn(bool isOn);
   virtual bool systemIsOn() const;

   virtual void setSystemMode(DtU8 mode );
   virtual DtU8 systemMode() const;

   virtual void setOperationalStatus(DtOperationalStatusEnum8 status);
   virtual DtOperationalStatusEnum8 operationalStatus() const;

   virtual void setTestModeIsOn(bool isOn);
   virtual bool testModeIsOn() const;

   virtual void setEmissionsDataAvailable(bool isAvailable);
   virtual bool emissionsDataAvailable() const;

   virtual void setBeamAzimuthCenter(DtFloat32 val);
   virtual DtFloat32 beamAzimuthCenter() const;

   virtual void setBeamAzimuthSweep(DtFloat32 val);
   virtual DtFloat32 beamAzimuthSweep() const;

   virtual void setBeamElevationCenter(DtFloat32 val);
   virtual DtFloat32 beamElevationCenter() const;

   virtual void setBeamElevationSweep(DtFloat32 val);
   virtual DtFloat32 beamElevationSweep() const;

   virtual void setBeamSweepSync(DtFloat32 val);
   virtual DtFloat32 beamSweepSync() const;

   virtual void setFundamentalParameterData(DtFundamentalParameterDataStructArray val);
   virtual DtFundamentalParameterDataStructArray fundamentalParameterData() const;

   virtual void setSupplementalData(DtIFFDataVariantStructArray val);
   virtual DtIFFDataVariantStructArray supplementalData() const;

/************** IFF SYSTEM TRANSPONDER ATTRIBUTES *****************/

   virtual void setEmergencyOn(bool val);
   virtual bool isEmergencyOn() const;

   virtual void setIdentSquawkFlashOn(bool val);
   virtual bool isIdentSquawkFlashOn() const;

   virtual void setUnmannedAircraftOn(bool val);
   virtual bool isUnmannedAircraftOn() const;

/************** IFF DATA ATTRIBUTES *****************/

   virtual void setSystemId(const DtGlobalObjectDesignator& globalId);
   virtual const DtGlobalObjectDesignator& systemId() const;

/************** IFF DATA MODE ACCESSORS *****************/
   virtual bool hasMode(DtModeType modeType) const;

   // General use Mode Enabler
   virtual void enableMode(DtModeType modeType) const;
   //virtual bool isEnabled(DtModeType modeType) const;

   virtual DtMode1StateRepository* mode1() const;

   virtual DtMode2StateRepository* mode2() const;
   
   virtual DtMode3AStateRepository* mode3A() const;

   virtual DtMode3CStateRepository* mode3C() const;

   virtual DtMode4StateRepository* mode4() const;

   virtual DtMode5StateRepository* mode5() const;

   virtual DtModeSStateRepository* modeS() const;

   virtual DtTCASDataStateRepository* tcasData() const;

   virtual DtSovietStateRepository* soviet() const;

   virtual DtRRBStateRepository* rrb() const;

/************** RPR 3.0 IFF ACCESSORS *****************/

   // Adding for RPR 3 API Refactor
   virtual void setModeEnabled(DtModeType modeType, bool val);
   virtual bool modeEnabled(DtModeType modeType) const;

   virtual void setModeIsMalfunctioning(DtModeType modeType, bool val);
   virtual bool modeIsMalfunctioning(DtModeType modeType) const;

   virtual void setModeIsDamaged(DtModeType modeType, bool val);
   virtual bool modeIsDamaged(DtModeType modeType) const;

   virtual void setModeIsOn(DtModeType modeType, bool val);
   virtual bool modeIsOn(DtModeType modeType) const;

/************** RPR 2.0 IFF ATTRIBUTES *****************/
//NOTE:  These are the attributes that don't exist or have been modified in RPR 3.0

   virtual void setSystemIsOperational(bool isOperational);
   virtual bool systemIsOperational() const;

/************** DIS-Specific IFF ATTRIBUTES *****************/
public:

   // DIS Base IFF PDU (Layer 1)
   virtual void setIffSimulationMode(bool on);
   virtual bool iffSimulationMode() const;

   virtual void setInteractiveCapable(bool on);
   virtual bool interactiveCapable() const;

   virtual void setModeCode(DtModeType modeCodeNum, DtU16 val);
   virtual DtU16 modeCode(DtModeType modeCodeNum) const;

   virtual void setStiOn(bool onOff);
   virtual bool stiOn() const;


   virtual void setLayer2DataAvailable(bool b);
   virtual bool layer2DataAvailable() const;

   virtual void setLayer2SpecificInfo(unsigned int val);
   virtual unsigned int layer2SpecificInfo() const;

   virtual void setSecondaryOperationalDataParameter1(
      DtIffOperationalParameter1 val);
   virtual DtIffOperationalParameter1 
      secondaryOperationalDataParameter1() const;

   virtual void setSecondaryOperationalDataParameter2(
      DtIffOperationalParameter2 val);
   virtual DtIffOperationalParameter2 
      secondaryOperationalDataParameter2() const;
 
   virtual int numParameterSets() const;
   virtual void setNumParameterSets(int n);

   virtual bool setParamData(int parmIndex,
      const DtIffAtcNavaidsParameter& init);
   virtual bool getParamData(int parmIndex,
      DtIffAtcNavaidsParameter& record) const;
   virtual DtIffAtcNavaidsParameter paramData(
      int paramIndex, bool *valid = NULL) const; 

#if DtDIS
   virtual int numIffRecords(int layer) const;
   virtual void setNumIffRecords(int n, int layer);

   virtual bool setIffRecord(int parmIndex,
      const DtIffAtcNavaidsVariableRecord& init, int layer);

   virtual DtIffAtcNavaidsVariableRecord* getIffRecord(int parmIndex, int layer) const;

   virtual void setSystemSpecificData(DtU8 b);
   virtual DtU8 systemSpecificData() const;


   virtual void setLayer3SpecificInfo(unsigned int val);
   virtual unsigned int layer3SpecificInfo() const;

   virtual void setLayer4SpecificInfo(unsigned int val);
   virtual unsigned int layer4SpecificInfo() const;

   virtual void setLayer5SpecificInfo(unsigned int val);
   virtual unsigned int layer5SpecificInfo() const;

   virtual void setLayer3DataAvailable(bool b);
   virtual bool layer3DataAvailable() const;

   virtual void setLayer4DataAvailable(bool b);
   virtual bool layer4DataAvailable() const;

   virtual void setLayer5DataAvailable(bool b);
   virtual bool layer5DataAvailable() const;

   virtual void setReportingSimulation(DtSimulationAddress b);
   virtual DtSimulationAddress reportingSimulation() const;

   virtual void setAvailableLayers(DtU8 value);
   virtual DtU8 availableLayers() const;

   virtual void setDataCategory(DtIffAtcNavaidsDataCategory value);
   virtual DtIffAtcNavaidsDataCategory dataCategory() const;

#endif //DtDIS

/************** IFF MODE SR ACCESSORS *****************/
public:
   // RPR FOM 3.0+ has dependent IFFData state repos for each mode.
   void setMode1StateRepository(DtMode1StateRepository* r) const;
   DtMode1StateRepository* mode1StateRepository() const;

   void setMode2StateRepository(DtMode2StateRepository* r) const;
   DtMode2StateRepository* mode2StateRepository() const;

   void setMode3AStateRepository(DtMode3AStateRepository* r) const;
   DtMode3AStateRepository* mode3AStateRepository() const;

   void setMode3CStateRepository(DtMode3CStateRepository* r) const;
   DtMode3CStateRepository* mode3CStateRepository() const;

   void setMode4StateRepository(DtMode4StateRepository* r) const;
   DtMode4StateRepository* mode4StateRepository() const;

   void setMode5StateRepository(DtMode5StateRepository* r) const;
   DtMode5StateRepository* mode5StateRepository() const;

   void setModeSStateRepository(DtModeSStateRepository* r) const;
   DtModeSStateRepository* modeSStateRepository() const;

   void setTCASDataStateRepository(DtTCASDataStateRepository* r) const;
   DtTCASDataStateRepository* tcasDataStateRepository() const;

   void setSovietStateRepository(DtSovietStateRepository* r) const;
   DtSovietStateRepository* sovietStateRepository() const;

   void setRRBStateRepository(DtRRBStateRepository* r) const;
   DtRRBStateRepository* rrbStateRepository() const;

public:

   static DtIffStateRepository* create();

   virtual void setEnabledModesChanged( bool changed );
   virtual bool enabledModesChanged();

protected:

   //RPR 3.0
   DtIffAtcNavaidsSysType myType; 
   DtIffAtcNavaidsSysName myName; 
   DtU8 mySystemDesignator;
   bool myInteractiveModeIsActive;
   DtEventId myEventId;
   bool mySystemIsOn;
   DtU8 mySystemMode;
   DtOperationalStatusEnum8 myOperationalStatus;
   bool myTestModeIsOn;
   bool myEmissionsDataAvailable;

   DtAntennaLocationIFFDataStructArray myAntennaLocationArray;
   DtIFFLayerSpecificInformationEnum8 myDataCommunicationsSpecificInformation;
   DtIFFDataVariantStructArray mySupplementalData;

   DtIFFLayerSpecificInformationEnum8 myEmissionsDataSpecificInformation;
   DtFloat32 myBeamAzimuthCenter;
   DtFloat32 myBeamAzimuthSweep;
   DtFloat32 myBeamElevationCenter;
   DtFloat32 myBeamElevationSweep;
   DtFloat32 myBeamSweepSync;
   DtFundamentalParameterDataStructArray myFundamentalParameterData;

   //DIS-Specific Layer 1 field
   DtU8 mySystemSpecificData;

   // No longer in RPR 3.0
   //RPR 2.0 in IFF and DIS Layer 1
   bool mySystemIsOperational; //DIS part of Layer 1 Fundamental Operational Data in System Status record
   bool myLayer2DataAvailable; //DIS part of Layer 1 Fundamental Operational Data in Informational Layers record

/************** DIS SPECIFIC ATTRIBUTES *****************/
   DtIffOperationalParameter1 mySecondaryOperationalDataParameter1;
   DtIffOperationalParameter2 mySecondaryOperationalDataParameter2;

   //TODO: figure these out
   int myLayer2SpecificInfo;
   int myNumParamSets;
   DtIffAtcNavaidsParameter* myParamSets;
   DtIffAtcNavaidsParameter myEmptyParamSet;
   
   //TODO: figure these out; DIS-specific?
   bool myIffSimulationMode;
   bool myInteractiveCapable;


/************** IFF DATA MODE SRs *****************/
   DtGlobalObjectDesignator mySystemId;
   
   mutable DtMode1StateRepository* myMode1;
   mutable DtMode2StateRepository* myMode2;
   mutable DtMode3AStateRepository* myMode3A;
   mutable DtMode3CStateRepository* myMode3C;
   mutable DtMode4StateRepository* myMode4;
   mutable DtMode5StateRepository* myMode5;
   mutable DtModeSStateRepository* myModeS;
   mutable DtTCASDataStateRepository* myTCASData;
   mutable DtSovietStateRepository* mySoviet;
   mutable DtRRBStateRepository* myRRB;

private:
   mutable DtMode1StateRepository* myOwnedMode1StateRepository;
   mutable DtMode2StateRepository* myOwnedMode2StateRepository;
   mutable DtMode3AStateRepository* myOwnedMode3AStateRepository;
   mutable DtMode3CStateRepository* myOwnedMode3CStateRepository;
   mutable DtMode4StateRepository* myOwnedMode4StateRepository;
   mutable DtMode5StateRepository* myOwnedMode5StateRepository;
   mutable DtModeSStateRepository* myOwnedModeSStateRepository;
   mutable DtTCASDataStateRepository* myOwnedTCASDataStateRepository;
   mutable DtSovietStateRepository* myOwnedSovietStateRepository;
   mutable DtRRBStateRepository* myOwnedRRBStateRepository;

public:
/************** IFFSYSTEM TRANSPONDER ATTRIBUTES *****************/
   bool myEmergencyOn;
   bool myStiOn; 
   bool myIdentSquawkFlashOn;
   bool myUnmannedAircraftOn;
   //DtU16 myModeCode[DtIFF_MODE_CODE_SIZE];

/************** DIS SPECIFIC ATTRIBUTES *****************/
#ifdef DtDIS
   DtSimulationAddress     myReportingSimulation;

   int myLayer3NumIffRecords;
   std::vector<DtIffAtcNavaidsVariableRecord*> myLayer3IffRecords;

   int myLayer4NumIffRecords;
   std::vector<DtIffAtcNavaidsVariableRecord*> myLayer4IffRecords;

   int myLayer5NumIffRecords;
   std::vector<DtIffAtcNavaidsVariableRecord*> myLayer5IffRecords;

   DtU8                        myLayers;
   DtIffAtcNavaidsDataCategory myDataCategory;

   bool myLayer3DataAvailable;
   bool myLayer4DataAvailable;
   bool myLayer5DataAvailable;

   int myLayer3SpecificInfo;
   int myLayer4SpecificInfo;
   int myLayer5SpecificInfo;
#endif

   //Internal helper member variables 
   mutable bool myEnabledModesChanged;
};