radioTransmitterStateComponent.h

Go to the documentation of this file.

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

#pragma once

#include "vrfStateData/vrfStateDataDefines.h"
#include "vrfStateData/doubleBufferedDataStorage.h"
#include "vrfStateData/stateComponent.h"
#include "vrfutil/rwUUID.h"
#include <legionStandardOM/sets/readRadioTransmitterRepository.hpp>
#include <legionStandardOM/sets/writeRadioTransmitterRepository.hpp>
#include <matrix/vlVector.h>
#include <vlpi/entityType.h>

namespace makVrf
{
   struct DT_DLL_vrfStateData DtRadioTransmitterStateComponentData
   {
      enum RadioInputSource
      {
         RadioInputOther,
         Pilot,
         CoPilot,
         FirstOfficer,
         Driver,
         Loader,
         Gunner,
         Commander,
         DigitalDataDevice,
         Intercom
      };

      DtRadioTransmitterStateComponentData()
      : myAntennaPatternType(0)
      , myPseudoNoiseInUse(false)
      , myTimeHopInUse(false)
      , myModulationParams(nullptr)
      , myModulationParamsSize(0)
      , myRadioId(0)
      {
      }

      DtRadioTransmitterStateComponentData(const DtRadioTransmitterStateComponentData& orig)
      : myWorldAntennaLoc(orig.myWorldAntennaLoc)
      , myRelativeAntennaLoc(orig.myRelativeAntennaLoc)
      , myAntennaPatternType(orig.myAntennaPatternType)
      , myPseudoNoiseInUse(orig.myPseudoNoiseInUse)
      , myTimeHopInUse(orig.myTimeHopInUse)
      , myModulationParams(nullptr)
      , myModulationParamsSize(0)
      , myRadioId(orig.myRadioId)
      {
         if (orig.myModulationParams)
         {
            myModulationParams = (char*)malloc(orig.myModulationParamsSize);
            memcpy(myModulationParams, orig.myModulationParams, orig.myModulationParamsSize);
            myModulationParamsSize = orig.myModulationParamsSize;
         }
      }

      virtual ~DtRadioTransmitterStateComponentData()
      {
         if (myModulationParams)
         {
            free(myModulationParams);
         }
      }

      DtRadioTransmitterStateComponentData& operator=(const DtRadioTransmitterStateComponentData& orig)
      {
         myRelativeAntennaLoc = orig.myRelativeAntennaLoc;
         myWorldAntennaLoc = orig.myWorldAntennaLoc;
         myRadioId = orig.myRadioId;
         myAntennaPatternType = orig.myAntennaPatternType;
         myPseudoNoiseInUse = orig.myPseudoNoiseInUse;
         myTimeHopInUse = orig.myTimeHopInUse;

         if (myModulationParams)
         {
            free(myModulationParams);
            myModulationParams = nullptr;
            myModulationParamsSize = 0;
         }

         if (orig.myModulationParams)
         {
            myModulationParams = (char*)malloc(orig.myModulationParamsSize);
            memcpy(myModulationParams, orig.myModulationParams, orig.myModulationParamsSize);
            myModulationParamsSize = orig.myModulationParamsSize;
         }

         return *this;
      }

      DEFINE_ACCESSOR_MUTATOR(DtVector, worldAntennaLoc, WorldAntennaLoc)
      DEFINE_ACCESSOR_MUTATOR(DtVector, relativeAntennaLoc, RelativeAntennaLoc)
      DEFINE_ACCESSOR_MUTATOR(unsigned int, antennaPatternType, AntennaPatternType)
      DEFINE_ACCESSOR_MUTATOR(UInt64, radioId, RadioId)
      DEFINE_ACCESSOR_MUTATOR(bool, pseudoNoiseInUse, PseudoNoiseInUse)
      DEFINE_ACCESSOR_MUTATOR(bool, timeHopInUse, TimeHopInUse)

      const char* modulationParams() const { return myModulationParams; };
      const unsigned char& modulationParamsSize() const { return myModulationParamsSize;  };

      void setModulationParams(const char* p, unsigned char l)
      {
         if (myModulationParams)
         {
            free(myModulationParams);
            myModulationParamsSize = 0;
            myModulationParams = nullptr;
         }

         if (p && l)
         {
            myModulationParams = (char*)malloc(l);
            memcpy(myModulationParams, p, l);
            myModulationParamsSize = l;
         }
      }

   protected:
      char* myModulationParams;
      unsigned char myModulationParamsSize;

      DtVector myWorldAntennaLoc;
      DtVector myRelativeAntennaLoc;
      unsigned int myAntennaPatternType;

      bool myPseudoNoiseInUse;
      bool myTimeHopInUse;

      UInt64 myRadioId;
   };

   class DT_DLL_vrfStateData DtRadioTransmitterStateComponent : public DtFrameStateInterface
   {
   public:
      DEFINE_STATE_COMPONENT_TYPE(DtStateComponent::RadioTransmitterStateComponent)

      DtRadioTransmitterStateComponent(DtStateData* storage)
      : DtFrameStateInterface(storage)
      {
      }

      UNDEFINED_RETURNVALUE_ACCESSOR(DtUUID, hostId)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, transmitState, TransmitState)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(DtRadioEntityType, radioEntityType, RadioEntityType)
      virtual const unsigned long long frequency() const { throw DtUnimplementedMethod("The const frequency() method is unimplemented"); };
      virtual void setFrequency(unsigned long long) { throw DtUnimplementedMethod("The const setFrquency(unsigned long long) method is unimplemented"); };
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(float, power, Power)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtVector, relativeAntennaLoc, RelativeAntennaLoc)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(DtVector, relativePosition, RelativePosition)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(DtVector, worldAntennaLoc, WorldAntennaLoc)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, inputSource, InputSource)
      UNDEFINED_RETURNVALUE_ACCESSOR(unsigned long, streamTagUpper)
      UNDEFINED_RETURNVALUE_ACCESSOR(unsigned long, streamTagLower)
      virtual const unsigned long long streamTag() const { throw DtUnimplementedMethod("The const streamTag() method is unimplemented"); };
      virtual void setStreamTag(unsigned long u, unsigned long l) { throw DtUnimplementedMethod("The const setStreamTag() method is unimplemented"); };
      virtual void setStreamTag(unsigned long long) { throw DtUnimplementedMethod("The const setStreamTag(unsigned long long) method is unimplemented"); };
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(unsigned int, antennaPatternType, AntennaPatternType)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(UInt64, radioId, RadioId)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, cryptoKey, CryptoKey)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, cryptoMode, CryptoMode)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, cryptoSystem, CryptoSystem)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, detailedModulationType, DetailedModulationType)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(float, frequencyBandwidth, FrequencyBandwidth)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(bool, frequencyHopInUse, FrequencyHopInUse)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(bool, pseudoNoiseInUse, PseudoNoiseInUse)
      UNDEFINED_RETURNREF_ACCESSOR_MUTATOR(bool, timeHopInUse, TimeHopInUse)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, majorModulationType, MajorModulationType)
      UNDEFINED_RETURNVALUE_ACCESSOR_MUTATOR(unsigned int, modulationSystemType, ModulationSystemType)
      UNDEFINED_RETURNVALUE_ACCESSOR(char*, modulationParams)
      UNDEFINED_RETURNREF_ACCESSOR(unsigned char, modulationParamsSize)
      virtual void setModulationParams(const char* params, unsigned char length) { throw DtUnimplementedMethod("The const setModulationParams() method is unimplemented"); };
   };

   class DT_DLL_vrfStateData DtRadioTransmitterStateComponentNextFrame : public DtRadioTransmitterStateComponent
   {
   public:
      DtRadioTransmitterStateComponentNextFrame(DtStateData*);

      virtual ~DtRadioTransmitterStateComponentNextFrame() override;

      const DtRadioTransmitterStateComponentData& frameState() const { return myData; };
      DtRadioTransmitterStateComponentData& frameState() { return myData; };

      virtual const DtUUID hostId() const override;

      virtual const unsigned int transmitState() const override;
      virtual void setTransmitState(const unsigned int&) override;

      virtual const unsigned int& antennaPatternType() const override;
      virtual void setAntennaPatternType(const unsigned int&) override;

      virtual const UInt64 radioId() const override;
      virtual void setRadioId(const UInt64&) override;

      virtual const DtRadioEntityType radioEntityType() const override;
      virtual void setRadioEntityType(const DtRadioEntityType&) override;

      virtual const unsigned long long frequency() const override;
      virtual void setFrequency(unsigned long long) override;

      virtual const unsigned long streamTagUpper() const override;
      virtual const unsigned long streamTagLower() const override;
      virtual const unsigned long long streamTag() const override;
      virtual void setStreamTag(unsigned long u, unsigned long l) override;
      virtual void setStreamTag(unsigned long long tag) override;

      virtual const float power() const override;
      virtual void setPower(const float&) override;

      virtual const char* modulationParams() const override;
      virtual const unsigned char& modulationParamsSize() const override;
      virtual void setModulationParams(const char* params, unsigned char length) override;

      virtual const DtVector& relativeAntennaLoc() const override;
      virtual void setRelativeAntennaLoc(const DtVector&) override;

      virtual const DtVector& worldAntennaLoc() const override;
      virtual void setWorldAntennaLoc(const DtVector&) override;

      virtual const DtVector relativePosition() const override;
      virtual void setRelativePosition(const DtVector&) override;

      virtual const unsigned int inputSource() const override;
      virtual void setInputSource(const unsigned int&) override;

      virtual const unsigned int cryptoKey() const override;
      virtual void setCryptoKey(const unsigned int&) override;

      virtual const unsigned int cryptoMode() const override;
      virtual void setCryptoMode(const unsigned int&) override;

      virtual const unsigned int cryptoSystem() const override;
      virtual void setCryptoSystem(const unsigned int&) override;

      virtual const unsigned int majorModulationType() const override;
      virtual void setMajorModulationType(const unsigned int&) override;

      virtual const unsigned int modulationSystemType() const override;
      virtual void setModulationSystemType(const unsigned int&) override;

      virtual const unsigned int detailedModulationType() const override;
      virtual void setDetailedModulationType(const unsigned int&) override;

      virtual const float frequencyBandwidth() const override;
      virtual void setFrequencyBandwidth(const float&) override;

      virtual const bool frequencyHopInUse() const override;
      virtual void setFrequencyHopInUse(const bool&) override;

      virtual const bool& pseudoNoiseInUse() const override;
      virtual void setPseudoNoiseInUse(const bool&) override;

      virtual const bool& timeHopInUse() const override;
      virtual void setTimeHopInUse(const bool&) override;

      virtual void makeWritable() override;

      virtual void makeReadOnly() override;

      UInt64 globalId() const;

      virtual Legion::WriteStateInstance writeStateInstance() override;
      virtual void updateStateData(DtStateData*) override;

      void cleanupWriteState();

      void setPublishingOnLegionNetwork(bool b);

   protected:
      bool myPublishingOnLegionNetwork;
      LOM::WriteRadioTransmitterRepository myWriteRadioTransmitterRepository;
      DtRadioTransmitterStateComponentData myData;
   };

   class DT_DLL_vrfStateData DtRadioTransmitterStateComponentCurrentFrame : public DtRadioTransmitterStateComponent
   {
   public:
      DtRadioTransmitterStateComponentCurrentFrame(DtStateData*);

      const DtRadioTransmitterStateComponentData& frameState() const { return myData; };

      virtual const DtUUID hostId() const override;
      virtual const unsigned int transmitState() const override;
      virtual const DtRadioEntityType radioEntityType() const override;
      virtual const unsigned long long frequency() const override;
      virtual const unsigned long long streamTag() const override;
      virtual const unsigned long streamTagUpper() const override;
      virtual const unsigned long streamTagLower() const override;
      virtual const float power() const override;
      virtual const DtVector& worldAntennaLoc() const override;
      virtual const DtVector& relativeAntennaLoc() const override;
      virtual const DtVector relativePosition() const override;
      virtual const unsigned int inputSource() const override;
      virtual const unsigned int& antennaPatternType() const override;
      virtual const UInt64 radioId() const override;
      virtual const unsigned int cryptoKey() const override;
      virtual const unsigned int cryptoMode() const override;
      virtual const unsigned int cryptoSystem() const override;
      virtual const unsigned int detailedModulationType() const override;
      virtual const float frequencyBandwidth() const override;
      virtual const bool frequencyHopInUse() const override;
      virtual const bool& pseudoNoiseInUse() const override;
      virtual const bool& timeHopInUse() const override;
      virtual const unsigned int majorModulationType() const override;
      virtual const unsigned int modulationSystemType() const override;
      virtual const char* modulationParams() const override;
      virtual const unsigned char& modulationParamsSize() const override;

      bool readComponentValid() const;
      bool findReadComponent();
      virtual Legion::ReadStateInstance readStateInstance() const override;

      UInt64 globalId() const;
      virtual void updateStateData(DtStateData*) override;

   protected:
      friend class DtRadioTransmitterStateComponentImplementation;
      void advanceFrame(const DtRadioTransmitterStateComponentData& data)
      {
         myData = data;
      }

   protected:
      LOM::ReadRadioTransmitterRepository myReadRadioTransmitterRepository;
      DtRadioTransmitterStateComponentData myData;
   };

   class DT_DLL_vrfStateData DtRadioTransmitterStateComponentImplementation : public DtDoubleBufferedStateComponent<DtRadioTransmitterStateComponent>
   {
   public:
      DtRadioTransmitterStateComponentImplementation(DtStateData* sd);

      bool isDoubleBuffered() { return true; };
      virtual const DtFrameStateInterface* currentFrameState() const override { return &myCurrentFrameState; }
      virtual DtFrameStateInterface* nextFrameState() override { return &myNextFrameState; };
      virtual const DtFrameStateInterface* nextFrameState() const override { return &myNextFrameState; };

      virtual void updateDataStorage() override
      {
         if (!myFoundComponent)
         {
            myFoundComponent = myCurrentFrameState.findReadComponent();
         }

         if (myNextFrameState.isWritable())
         {
            myCurrentFrameState.advanceFrame(myNextFrameState.frameState());
         }

         myCurrentFrameState.emitComponentUpdated();
      }

      virtual void updateStateData(DtStateData* sd) override
      {
         myCurrentFrameState.updateStateData(sd);
         myNextFrameState.updateStateData(sd);
      }

      virtual bool forceAdvance() override;

      virtual void firstFrameAdvance() override;

      virtual void aboutToBeDeleted() override
      {
         DtDoubleBufferedStateComponent<DtRadioTransmitterStateComponent>::aboutToBeDeleted();
         myCurrentFrameState.aboutToBeDeleted();
         myNextFrameState.aboutToBeDeleted();
      }

      virtual void completeSetup() override;
      virtual void removeAdditionalStateComponents() override;
      virtual void setPublishingOnLegionNetwork(bool b) override;

   protected:
      DtRadioTransmitterStateComponentCurrentFrame myCurrentFrameState;
      DtRadioTransmitterStateComponentNextFrame myNextFrameState;
      bool myFoundComponent;
   };

   typedef DtStateComponentCreator<DtRadioTransmitterStateComponentImplementation> DtRadioTransmitterStateComponentCreator;
}