vrfGuiSettingsRecord.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.h>
#include <vrvUtil/DtUnicode.h>

#include <boost/serialization/access.hpp>
#include <boost/serialization/nvp.hpp>
#include <boost/serialization/list.hpp>
#include <boost/serialization/map.hpp>
#include <boost/serialization/vector.hpp>
#include <boost/serialization/string.hpp>

namespace makVrf
{
   class DT_DLL_VRFGUICORE DtVrfGuiSettingsRecord
   {
   public:
      enum VrfGuiSettingsOptions
      {
         DtDisplayCorrelationWarningMessages =  0x00000020,
         DtShowSessionStartupDialog       = 0x00000040,
         DtStartOnNewScenario           = 0x00000080,
         DtStartOnLoadRecentScenario           = 0x00000100,
         DtStartOnLoadScenarioFromDisk           = 0x00000200,
         DtUserDefinedSmoothing             = 0x00000800,
         DtShowScenarioDescriptionDialog    = 0x00001000,
         DtZoomToScenarioExtentsOnLoad    = 0x00002000,
         DtUseAdditionalWindowTitle    = 0x00004000,
         DtUseSimulationTimeForAdvancement    = 0x00008000,
         DtShowOverlayBar              = 0x00010000,
         DtUseStartFreezePdus       = 0x00080000,
         DtSortTaskSetMenus = 0x00100000,
         DtAllowWindowsStyleNameEditing = 0x00200000,
         PromptBeforeAbandoningPlan =  0x00400000,
         PromptBeforeInterruptingTask = 0x00800000,
         GrayOutHiddenItems = 0x01000000,
         OrganizeOverlaysByCategory = 0x02000000
      };

   public:
      DtVrfGuiSettingsRecord();
      DtVrfGuiSettingsRecord(const DtVrfGuiSettingsRecord& orig);

      virtual ~DtVrfGuiSettingsRecord();

   public:

      virtual void setFlag(int flag, bool set);

      virtual void setUseStartFreezePdus(bool);
      virtual bool useStartFreezePdus() const;

      void setZoomToScenarioExtentsOnLoad(bool);
      bool zoomToScenarioExtentsOnLoad() const;

      void setDisplayCorrelationWarningMessages(bool);
      bool displayCorrelationWarningMessages() const;

      void setShowSessionStartupDialog(bool);
      bool showSessionStartupDialog() const;

      void setSortTaskSetMenus(bool);
      bool sortTaskSetMenus() const;

      void setAllowWindowsStyleNameEditing(bool);
      bool allowWindowsStyleNameEditing() const;

      void setGrayOutHiddenItems(bool);
      bool grayOutHiddenItems() const;

      void setOrganizeOverlaysByCategory(bool);
      bool organizeOverlaysByCategory() const;

      void setEditPressTime(double);
      double editPressTime() const;

      void setStartupPreference(int);
      int startupPreference() const;

      virtual void setUseSimulationTimeForAdvancement(bool);
      virtual bool useSimulationTimeForAdvancement() const;

      virtual void setShowOverlayBar(bool);
      virtual bool showOverlayBar() const;

      void setShowScenarioDescriptionDialog(bool);
      bool showScenarioDescriptionDialog() const;

      void setUserDefinedSmoothing(bool);
      bool userDefinedSmoothing() const;

      virtual void setTimeScaleRange(double low, double high);
      virtual void getTimeScaleRange(double& low, double& high) const;

      void setHelpFile(const std::string&);
      const std::string& helpFile() const;

      virtual void setUseAdditionalWindowTitle(bool);
      virtual bool useAdditionalWindowTitle() const;

      virtual void setAdditionalWindowTitle(const makVrv::DtUnicode&);
      virtual makVrv::DtUnicode additionalWindowTitle() const;

      virtual void setTimescaleButtonMode(bool);
      virtual bool timescaleButtonMode();

      virtual void setTimescaleButtons(const std::string&);
      virtual const std::string& timescaleButtons() const;

      virtual void setPromptBeforeAbandoningPlan(bool);
      virtual bool promptBeforeAbandoningPlan() const;

      virtual void setPromptBeforeInterruptingTask(bool);
      virtual bool promptBeforeInterruptingTask() const;

   protected:
      friend class boost::serialization::access;

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(myGuiOptions);
         ar & BOOST_SERIALIZATION_NVP(myHelpFile);
         ar & BOOST_SERIALIZATION_NVP(myAdditionalWindowTitle);
         ar & BOOST_SERIALIZATION_NVP(myTimescaleLow);
         ar & BOOST_SERIALIZATION_NVP(myTimescaleHigh);

         if (version >= 2)
         {
            ar & BOOST_SERIALIZATION_NVP(myTimescaleButtonMode);
            ar & BOOST_SERIALIZATION_NVP(myTimescaleButtons);

            if (version >= 3)
            {
               ar & BOOST_SERIALIZATION_NVP(myEditPressTime);
            }
         }

         if (Archive::is_loading::value && (version <= 3))
         {
            int flags = myGuiOptions;
            flags |= (PromptBeforeAbandoningPlan | PromptBeforeInterruptingTask);
            myGuiOptions = (VrfGuiSettingsOptions)flags;
         }

         if (Archive::is_loading::value && (version <= 4))
         {
            int flags = myGuiOptions;
            flags |= (GrayOutHiddenItems | OrganizeOverlaysByCategory);
            myGuiOptions = (VrfGuiSettingsOptions)flags;
         }
      }

   protected:
      VrfGuiSettingsOptions   myGuiOptions;
      std::string myHelpFile;
      std::string myAdditionalWindowTitle;
      std::string myTimescaleButtons;
      bool myTimescaleButtonMode;
      double myTimescaleLow;
      double myTimescaleHigh;
      double myEditPressTime;
   };
}

BOOST_CLASS_VERSION(makVrf::DtVrfGuiSettingsRecord,5)