DtSharedRadioCommunicationsSettings.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCore/vrvCore.h>

#include <vrvCore/DtSharedSettings.h>

#include <vrvCore/DtRecordSettingsBackup.h>

#include <makArchives/DtRadioCommunicationsSettingsRecord.h>

#include <boost/unordered_map.hpp>

#include <vrvUtil/event_signal.h>
#include <vrvUtil/DtBaseSettingsManager.h>

#include <vector>

namespace makVrv
{

   class DtSharedRadioCommunicationsSettings;

   typedef DtSharedRecordSettingsBackup<DtSharedRadioCommunicationsSettings,
      makArchives::DtRadioCommunicationsSettingsRecord> DtRadioCommunicationsSettingsBackup;

   class DT_DLL_VRVCORE DtSharedRadioCommunicationsSettings : public DtSharedSettings
   {
   protected:

      typedef makArchives::DtRadioCommunicationsSettingsRecord::CommLineMode
         CommLineMode;

      typedef makArchives::DtRadioCommunicationsSettingsRecord::DefaultColoringMode
         DefaultColoringMode;

   public:

      virtual ~DtSharedRadioCommunicationsSettings();



      virtual float commLineLifetime() const;
      virtual void setCommLineLifetime( float lifetime );

      virtual float squawkIndicatorLifetime() const;
      virtual void setSquawkIndicatorLifetime( float lifetime );

      virtual float commLineAnimationRate() const;
      virtual void setCommLineAnimationRate( float rate );

      virtual float squawkIndicatorAnimationRate() const;
      virtual void setSquawkIndicatorAnimationRate( float rate );

      virtual bool displayCommLines() const;
      virtual void setDisplayCommLines( bool show );

      virtual bool displaySquawkIndicators() const;
      virtual void setDisplaySquawkIndicators( bool show );

      virtual bool displayRadioCommunications() const;
      virtual void setDisplayRadioCommunications( bool show );

      virtual CommLineMode commLineRenderMode() const;
      virtual void setCommLineRenderMode( CommLineMode mode );

      virtual double greatCircleExaggerationAmount() const;
      virtual void setGreatCircleExaggerationAmount( double amount );

      virtual DefaultColoringMode defaultColoringMode() const;
      virtual void setDefaultColoringMode( DefaultColoringMode mode );



      virtual bool showDefaultFrequency() const;
      virtual void setShowDefaultFrequency( bool show );

      virtual void getDefaultFrequencyColor( float& r, float& g, float& b ) const;
      virtual void setDefaultFrequencyColor( float r, float g, float b );



      virtual void getFrequencyRange( int rangeIndex, float& lowFreq, float& highFreq ) const;
      virtual int addFrequencyRange( float lowFreq, float highFreq );

      virtual void getFrequencyRangeColor( int rangeIndex, float& r, float& g, float& b ) const;
      virtual void setFrequencyRangeColor( int rangeIndex, float r, float g, float b );

      virtual bool showFrequencyRangeFrequency( int rangeIndex ) const;
      virtual void setShowFrequencyRangeFrequency( int rangeIndex, bool show );

      virtual int numFrequencyRanges() const;

      virtual void clearFrequencyRanges();




      void setFromRecord( const makArchives::DtRadioCommunicationsSettingsRecord& rec );

      void getRecord( makArchives::DtRadioCommunicationsSettingsRecord& rec ) const;

      virtual const DtRadioCommunicationsSettingsBackup* settingsBackup() const;

      virtual DtRadioCommunicationsSettingsBackup* settingsBackup();

      virtual void backup();


      static const std::string& className();

   protected:

      friend class DtReadSettingsLock<DtSharedRadioCommunicationsSettings>;
      friend class DtWriteSettingsLock<DtSharedRadioCommunicationsSettings>;
      friend class DtBaseSharedSettingsManager<makArchives::DtRadioCommunicationsSettingsRecord, DtSharedRadioCommunicationsSettings>;

      DtSharedRadioCommunicationsSettings( DtSharedSettingsManager& manager );

      bool applyFactoryOverrides(
         makArchives::DtRadioCommunicationsSettingsRecord& rec) const;

   protected:

      struct FrequencyRangeAttributes
      {

         FrequencyRangeAttributes()
            : myHighFrequency( -1 )
            , myLowFrequency( -1 )
            , myShowFrequencyFlag( true )
         {
            // Default myColor: magenta
            myColor[0] = myColor[2] = 1.0;
            myColor[1] = 0.0;
         }

         float myHighFrequency;
         float myLowFrequency;
         bool myShowFrequencyFlag;
         float myColor[3];

      };

   protected:

      typedef std::vector<FrequencyRangeAttributes> FrequencyRangeAttributesList;

      FrequencyRangeAttributesList myFrequencyRangeAttributes;

      float myDefaultFrequencyRangeColor[3];
      bool myShowDefaultFrequencyFlag;

      float myCommLineLifetime;
      float mySquawkIndicatorLifetime;

      float myCommLineAnimationRate;
      float mySquawkIndicatorAnimationRate;

      bool myDisplayCommLinesFlag;
      bool myDisplaySquawkIndicatorsFlag;
      bool myDisplayRadioCommunicationsFlag;
      CommLineMode myCommunicationLineRenderMode;
      float myGreatCircleExaggerationAmount;
      DefaultColoringMode myDefaultColoringMode;

      DtRadioCommunicationsSettingsBackup* mySettingsBackup;

   };

}