DtSharedDisplayUnitsSettings.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/DtDisplayUnitsSettingsRecord.h>

#include <vrvUtil/DtUnitConverterCollection.h>
#include <vrvUtil/DtUnicode.h>
#include <vrvUtil/DtBaseSettingsManager.h>

#include <vector>
#include <unordered_map>

namespace makVrv
{

   class DtCoordinateSystem;
   class DtSharedDisplayUnitsSettings;

   typedef DtSharedRecordSettingsBackup<DtSharedDisplayUnitsSettings,
      makArchives::DtDisplayUnitsSettingsRecord> DtDisplayUnitsSettingsBackup;

   class DT_DLL_VRVCORE DtSharedDisplayUnitsSettings : public DtSharedSettings
   {
   public:

      friend class DisplayAttributes;

      typedef makArchives::DtDisplayUnitsSettingsRecord::CoordSys CoordSys;
      typedef makArchives::DtDisplayUnitsSettingsRecord::DistanceUnits DistanceUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::VelocityUnits VelocityUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::AccelerationUnits AccelerationUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::OrientationUnits OrientationUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::RotVelocityUnits RotVelocityUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::TemperatureUnits TemperatureUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::PressureUnits PressureUnits;
      typedef makArchives::DtDisplayUnitsSettingsRecord::NorthUnits NorthUnits;

      struct UnitEntry
      {
         DtUnicode myUnitName; // The display name for this unit of measurement
         DtUnicode myNotation; // The notation for this unit of measurement
         unsigned int myEnumerationValue;

         UnitEntry( DtUnicode name, DtUnicode notation, unsigned int enumValue )
            : myUnitName( name )
            , myNotation( notation )
            , myEnumerationValue( enumValue )
         {
            // intentional noop
         }
      };

      typedef makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitAttributes DisplayAttributes;

      typedef std::vector<UnitEntry> Units;

      typedef std::unordered_map<makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType, Units> UnitMap;

      typedef std::map<std::string, DisplayAttributes> DisplayUnitMap;

      typedef std::unordered_map<std::string, DisplayUnitMap> DisplayUnitCollectionMap;

      const static DtUnicode theApplicationDisplayUnitCollectionName;
      const static DtUnicode theWeatherDisplayUnitCollectionName;
      const static DtUnicode theDefaultDisplayUnitCollectionName;
      const static DtUnicode theMunitionDisplayUnitCollectionName;
      const static DtUnicode theFixedWingDisplayUnitCollectionName;
      const static DtUnicode theRotaryWingDisplayUnitCollectionName;
      const static DtUnicode theLifeFormDisplayUnitCollectionName;
      const static DtUnicode theGroundDisplayUnitCollectionName;
      const static DtUnicode theSurfaceDisplayUnitCollectionName;
      const static DtUnicode theSubsurfaceDisplayUnitCollectionName;
      const static DtUnicode theSpaceDisplayUnitCollectionName;
      
      const static DtUnicode theSmallDistanceDisplayUnitName;
      const static DtUnicode theDistanceDisplayUnitName;
      const static DtUnicode theAltitudeDisplayUnitName;
      const static DtUnicode theSpeedDisplayUnitName;
      const static DtUnicode theRotationalVelocityDisplayUnitName;
      const static DtUnicode theAccelerationDisplayUnitName;
      const static DtUnicode theOrientationDisplayUnitName;
      const static DtUnicode theHeadingDisplayUnitName;
      const static DtUnicode theCoordinateSystemDisplayUnitName;
      const static DtUnicode theSensorViewCoordinateSystemDisplayUnitName;
      const static DtUnicode theVisibilityDisplayUnitName;
      const static DtUnicode thePressureDisplayUnitName;
      const static DtUnicode theTemperatureDisplayUnitName;
      const static DtUnicode thePrecipitationDepthDisplayUnitName;
      const static DtUnicode thePrecipitationRateDisplayUnitName;
      const static DtUnicode theWindSpeedDisplayUnitName;
      const static DtUnicode theDirectionDisplayUnitName;
      const static DtUnicode theRangeMeasurementDisplayUnitName;
      const static DtUnicode theBearingMeasurementDisplayUnitName;
      const static DtUnicode the3DCompassDisplayUnitName;

   public:
      virtual ~DtSharedDisplayUnitsSettings();


      void setUnitAttributes(
         makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType displayUnitType,
         const Units& data);

      bool getUnitAttributes(
         makArchives::DtDisplayUnitsSettingsRecord::DisplayUnitType displayUnitType,
         Units& value) const;

      const DisplayUnitCollectionMap& displayUnitCollectionMap() const;
      
      DisplayUnitCollectionMap& displayUnitCollectionMap();

      void setDisplayUnitAttributes(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName, 
         const DisplayAttributes& data );

      bool getDisplayUnitAttributes(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName,
         DisplayAttributes& value ) const;

      DisplayAttributes* findDisplayUnitAttributes(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName );

      const DisplayAttributes* findDisplayUnitAttributes(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName ) const;

      void setSuppressMagneticNorthNotationEnabled(bool isEnabled);

      bool isSuppressMagneticNorthNotationEnabled() const;



      void setCoordinateSystem( CoordSys cs );



      void setDisplayUnitUnit(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName,
         unsigned int unitEnumerationValue
      );

      void setDisplayUnitDecimals(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName,
         unsigned int decimals
      );

      unsigned int displayUnitUnit(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName) const;

      unsigned int displayUnitDecimals(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName) const;

      DtUnicode displayUnitNotation(
         const DtUnicode& displayUnitCollectionName,
         const DtUnicode& displayUnitName) const;


      DtUnicode coordinateSystemNotation(CoordSys cs) const;
      DtUnicode distanceUnitNotation(DistanceUnits distUnit) const;
      DtUnicode velocityUnitNotation(VelocityUnits velocityUnit) const;
      DtUnicode orientationUnitNotation(OrientationUnits oriUnit) const;
      DtUnicode accelerationUnitNotation(AccelerationUnits accelUnit) const;
      DtUnicode rotationalVelocityUnitNotation(RotVelocityUnits wUnit) const;
      DtUnicode temperatureUnitNotation(TemperatureUnits tempUnit) const;
      DtUnicode pressureUnitNotation(PressureUnits pressureUnit) const;
      DtUnicode northUnitNotation(NorthUnits northUnit) const;


      CoordSys currentCoordinateSystem() const;
      int currentCoordinateSystemDecimals() const;
      DtUnicode currentCoordinateSystemNotation() const;
      

      void coordinateSystemLabels( const DtCoordinateSystem& displayCS,
         DtUnicode& x, DtUnicode& y, DtUnicode& z ) const;

      void coordinateSystemLabels( const DtCoordinateSystem& displayCS,
         CoordSys coordSys,
         DtUnicode& x, DtUnicode& y, DtUnicode& z ) const;

      DtUnicode xyUnitNotation(
         const DtCoordinateSystem& displayCS ) const;

      DtUnicode xyUnitNotation( const DtCoordinateSystem& displayCS,
         CoordSys coordSys ) const;

      DtUnicode zUnitNotation(
         const DtCoordinateSystem& displayCS ) const;

      DtUnicode zUnitNotation( const DtCoordinateSystem& displayCS,
         CoordSys coordSys ) const;


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

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

      virtual const DtDisplayUnitsSettingsBackup* settingsBackup() const;

      virtual DtDisplayUnitsSettingsBackup* settingsBackup();

      virtual void backup();


   protected:

      friend class DtReadSettingsLock<DtSharedDisplayUnitsSettings>;
      friend class DtWriteSettingsLock<DtSharedDisplayUnitsSettings>;
      friend class DtBaseSharedSettingsManager<makArchives::DtDisplayUnitsSettingsRecord, DtSharedDisplayUnitsSettings>;

      DtSharedDisplayUnitsSettings( DtSharedSettingsManager& manager );

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

      CoordSys currentCoordSysIndex() const;

      int currentCoordSysDecimals() const;

      std::string valueToText( double value, int decimals ) const;

      static const std::string& className();

      void initEntries();

   protected:

      UnitMap myUnits;
      DisplayUnitCollectionMap myDisplayUnits;

      bool mySuppressMagneticNorthNotationEnabled;

      DtDisplayUnitsSettingsBackup* mySettingsBackup;

   };

}