vrfSessionSettingsRecord.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2015 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 DtVrfSessionSettingsRecord
   {
   public:
      enum VrfSessionSettingsOptions
      {
         DtAutoJoinSession                =  0x00000001,
         DtAskToJoin                      =  0x00000002,
         DtAlwaysJoinWithSessionDatabase  =  0x00000004,
         DtAlwaysJoinWithOpenDatabase     =  0x00000008,
         DtShowSessionDialogs             =  0x00000010,
         DtAllowScenarioChanges           =  0x00000040,
         DtAutomaticallyOpenSessionDatabaseWithoutJoiningSession                =  0x00040000,
      };

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

      virtual ~DtVrfSessionSettingsRecord();

   public:

      virtual void setFlag(int flag, bool set);

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

      void setAutomaticallyOpenSessionDatabaseWithoutJoiningSession(bool);
      bool automaticallyOpenSessionDatabaseWithoutJoiningSession() const;

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

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

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

      void setAllowScenarioChanges(bool);
      bool allowScenarioChanges() const;

      virtual void setDisplaySessionDialogs(bool);
      virtual bool displaySessionDialogs() 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 < 15) && (Archive::is_loading::value))
         {
            return;
         }
         else if ((version == 15) && (Archive::is_loading::value))
         {
            setAllowScenarioChanges(true);
         }
      }

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

BOOST_CLASS_VERSION(makVrf::DtVrfSessionSettingsRecord,16)