DtRadioCommunicationsSettingsRecord.h

Go to the documentation of this file.

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


#pragma once

#include <makArchives/makArchives.h>

namespace makArchives
{

   class DT_DLL_MAKARCHIVES DtRadioCommunicationsSettingsRecord
   {
   public:

      enum CommLineMode
      {
         LineOfSight,
         CurvedEarth
      };

      enum DefaultColoringMode
      {
         FixedColoring,
         ForceColoring
      };

   public:

      DtRadioCommunicationsSettingsRecord();

      DtRadioCommunicationsSettingsRecord( const DtRadioCommunicationsSettingsRecord& rec );

      DtRadioCommunicationsSettingsRecord& operator = ( const DtRadioCommunicationsSettingsRecord& rec );

      virtual ~DtRadioCommunicationsSettingsRecord();



      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 communicationLineRenderMode() const;
      virtual void setCommunicationLineRenderMode( CommLineMode mode );

      virtual float greatCircleExaggerationAmount() const;
      virtual void setGreatCircleExaggerationAmount( float 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 getFrequencyRangeColor( int rangeIndex, float& r, float& g, float& b ) const;
      virtual void setFrequencyRangeColor( int rangeIndex, float r, float g, float b );

      virtual bool frequencyRangeVisibility( int rangeIndex ) const;
      virtual void setFrequencyRangeVisibility( int rangeIndex, bool show );

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

      virtual int numFrequencyRanges() const;



   protected:

      friend class boost::serialization::access;

      template<class Archive>
      void serialize( Archive& ar, /*const*/ unsigned int version )
      {
         ar & BOOST_SERIALIZATION_NVP( myDefaultFrequencyColor );
         ar & BOOST_SERIALIZATION_NVP( myShowDefaultFrequencyFlag );
         ar & BOOST_SERIALIZATION_NVP( myCommLineLifetime );
         ar & BOOST_SERIALIZATION_NVP( mySquawkIndicatorLifetime );
         ar & BOOST_SERIALIZATION_NVP( myCommLineAnimationRate );
         ar & BOOST_SERIALIZATION_NVP( mySquawkIndicatorAnimationRate );
         ar & BOOST_SERIALIZATION_NVP( myDisplaySquawkIndicatorsFlag );
         ar & BOOST_SERIALIZATION_NVP( myDisplayCommLinesFlag );
         ar & BOOST_SERIALIZATION_NVP( myDisplayRadioCommunicationsFlag );
         ar & BOOST_SERIALIZATION_NVP( myCommunicationLineRenderMode );
         ar & BOOST_SERIALIZATION_NVP( myDefaultColoringMode );
         ar & BOOST_SERIALIZATION_NVP( myFrequencyVisibilities );
         ar & BOOST_SERIALIZATION_NVP( myFrequencyColors );
         ar & BOOST_SERIALIZATION_NVP( myFrequencyRanges );

         if ( version >= 2 )
         {
            ar & BOOST_SERIALIZATION_NVP( myGreatCircleExaggerationAmount );
         }
      }

   protected:

      struct FrequencyRange
      {
         FrequencyRange()
            : myLowFrequency( 0 )
            , myHighFrequency( 0 )
         {}

         FrequencyRange( float lowFreq, float highFreq )
            : myLowFrequency( lowFreq )
            , myHighFrequency( highFreq )
         {}

         template<class Archive>
         void serialize( Archive& ar, /*const*/ unsigned int version )
         {
            ar & BOOST_SERIALIZATION_NVP( myLowFrequency );
            ar & BOOST_SERIALIZATION_NVP( myHighFrequency );
         }

         float myLowFrequency, myHighFrequency;

      };

      struct Color
      {
         Color()
            : myRed( 1.0f )
            , myGreen( 1.0f )
            , myBlue( 1.0f )
         {}

         Color( float red, float green, float blue )
            : myRed( red )
            , myGreen( green )
            , myBlue( blue )
         {}

         template<class Archive>
         void serialize( Archive& ar, /*const*/ unsigned int version )
         {
            ar & BOOST_SERIALIZATION_NVP( myRed );
            ar & BOOST_SERIALIZATION_NVP( myGreen );
            ar & BOOST_SERIALIZATION_NVP( myBlue );
         }

         float myRed, myGreen, myBlue;

      };

   protected:

      typedef std::vector<FrequencyRange> FrequencyRangesList;

      typedef std::map<int,Color> FrequencyRangeColorsMap;

      typedef std::map<int,bool> FrequencyRangesEnabledMap;

      FrequencyRangesEnabledMap myFrequencyVisibilities;
      FrequencyRangeColorsMap myFrequencyColors;
      FrequencyRangesList myFrequencyRanges;

      Color myDefaultFrequencyColor;
      bool myShowDefaultFrequencyFlag;

      float myCommLineLifetime;
      float mySquawkIndicatorLifetime;
      float myCommLineAnimationRate;
      float mySquawkIndicatorAnimationRate;

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

   };

}

BOOST_CLASS_VERSION( makArchives::DtRadioCommunicationsSettingsRecord, 2 );
BOOST_CLASS_VERSION( makArchives::DtRadioCommunicationsSettingsRecord::Color, 1 );
BOOST_CLASS_VERSION( makArchives::DtRadioCommunicationsSettingsRecord::FrequencyRange, 1 );