DtVrfSessionSettingsRecord.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCore/vrfGuiCore.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 DtVrfSessionSettingsRecord
   {
   public:
      enum VrfSessionSettingsOptions
      {
         DtAutoJoinSession                =  0x00000001,
         DtAskToJoin                      =  0x00000002,
         DtAlwaysJoinWithSessionDatabase  =  0x00000004,
         DtAlwaysJoinWithOpenDatabase     =  0x00000008,
         DtShowSessionDialogs             =  0x00000010,
         DtDisplayCorrelationWarningMessages =  0x00000020,
         DtShowSessionStartupDialog       = 0x00000040,
         DtStartOnNewVRTheWorld           = 0x00000080,
         DtStartOnNewScenario           = 0x00000100,
         DtStartOnLoadScenario           = 0x00000200,
         DtAggregateOnCreate             = 0x00000400,
         DtUserDefinedSmoothing             = 0x00000800,
         DtShowScenarioDescriptionDialog    = 0x00001000,
         DtZoomToScenarioExtentsOnLoad    = 0x00002000,
      };

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

      virtual ~DtVrfSessionSettingsRecord();

   public:

      virtual void setFlag(int flag, bool set);

      void setAutoJoinSession(bool);
      bool autoJoinSession() const;

      void setAskToJoin(bool);
      bool askToJoin() const;

      void setAlwaysJoinWithSessionDatabase(bool);
      bool alwaysJoinWithSessionDatabase() const;

      void setAlwaysJoinWithOpenDatabase(bool);
      bool alwaysJoinWithOpenDatabase() const;

      void setDisplaySessionDialogs(bool);
      bool displaySessionDialogs() const;

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

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

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

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

      void setAggregateOnCreate(bool);
      bool aggregateOnCreate() const;

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

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

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

      void setDefaultScenarioFile(const std::string&);
      const std::string& defaultScenarioFile() const;

      void setDefaultSimulationModelSetFile(const std::string&);
      const std::string& defaultSimulationModelSetFile() const;

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

      template<class Archive>
         void serialize(Archive & ar, const unsigned int version)
      {
         ar & BOOST_SERIALIZATION_NVP(mySessionOptions);

         if ((version == 1) && (Archive::is_loading::value))
         {
            setFlag(DtShowSessionStartupDialog, true);
         }
         else if ((version == 2) && (Archive::is_loading::value))
         {
            myHelpFile = "../doc/help/vr-forces_help.qhc";
         }
         else if (version >= 4)
         {
            ar & BOOST_SERIALIZATION_NVP(myHelpFile);
            ar & BOOST_SERIALIZATION_NVP(myDefaultScenarioFile);
            ar & BOOST_SERIALIZATION_NVP(myDefaultSimulationModelSetFile);
         }
      }

   protected:
      VrfSessionSettingsOptions   mySessionOptions;
      std::string myHelpFile;
      std::string myDefaultScenarioFile;
      std::string myDefaultSimulationModelSetFile;
   };
}

BOOST_CLASS_VERSION(makVrf::DtVrfSessionSettingsRecord,4)