vrfSaveScenarioHandler.h

Go to the documentation of this file.

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



#pragma once

#include <vrfGuiCoreQt/vrfGuiCoreQt.h>

#include <vrvUtil/DtVirtualBaseClass.h>
#include <vrvUtil/signalslib.h>
#include <vrvCore/DtDe.h>

#include <boost/signal.hpp>

#include <QtCore/QString>

class DtScenario;

namespace makVrf
{
   const int DtSaveCurrentCheckpoint = 0x00000001;

   class DT_DLL_VRFGUICOREQT DtVrfSaveScenarioHandler : public makVrv::DtVirtualBaseClass
   {
   public:
      DtVrfSaveScenarioHandler(makVrv::DtDe&);
      virtual ~DtVrfSaveScenarioHandler();

      static DtVrfSaveScenarioHandler& instance(makVrv::DtDe& de);

      virtual bool saveScenarioAs();


      virtual int saveScenario(bool forceOverwrite = false, bool queueSave = false, bool useScenarioNameAsSeed = true);

      virtual void setScenario(const DtScenario*);

      virtual std::string defaultObserverView() const;
      virtual void setDefaultObserverView(const std::string&);

      virtual bool saveScenario(const QString& s, bool setAsSaved = true, bool queueSave = false,
         bool preserveBackendMappings = true, bool startPlayingAfterSave = false);
      virtual bool setupScenarioToSave(const QString& filename, bool setAsSaved);

      virtual bool getScenarioSaveName(QString&, bool* asked = 0, bool useScenarioNameAsSeed = true) const;

      virtual DtFilename saveScenarioName(bool askIfDoesNotExist = true, bool* asked = 0, bool useScenarioNameAsSeed = true) const;

      virtual void setCheckpointIdentifier(const std::string&);
      virtual const std::string& checkpointIdentifier() const;

      virtual DtFilename chooseScenarioNameBasedOn(const DtScenario&, bool saveIntoScenario = false);

      virtual QString makeRelativeTo(QString origFile, QString path) const;

      virtual void checkpointScenario(const QString& baseFilename, bool forceOverwrite = false, bool queueSave = false,
         bool startPlayingAfterSave = false);

      virtual QString checkpointIdentifier(const QString& filename, bool plain = false) const;
      virtual QString checkpointIdentifier(const QString& filename, double currentSimTime, bool plain = false) const;
      virtual QString getTimeString(double time, char separator = '_') const;

      virtual void setDataIntoScenario(DtScenario&);

      virtual DtScenario* initializeCheckpointedScenario(const DtFilename& scenarioName, double simTime);

      virtual std::string scenarioExtentInformation() const;

      virtual void newScenario();

      const DtScenario* scenario() const
      {
         return myScenario;
      }

      virtual void setSaving(bool);
      virtual bool saving() const { return mySaving; };

      DtFilename savedFilename() const;

      boost::signal<void (DtScenario*)> signal_scenarioInformationAboutToBeSaved;

      boost::signal<void (DtScenario*)> signal_scenarioAboutToBeSaved;

   protected:
      virtual QString createFilterList() const;
      virtual QString startingDirectory() const;

      virtual QString relativePath() const;
      virtual QString dataFolder() const;

      static bool preserveMappings(void*);
      virtual bool processPreserveMappings();

   protected:
      virtual bool saveSelectionGroups(const QString& scenarioName, QString& selectionGroups, bool saveToZip) const;
      virtual bool saveOverlays(const QString& scenarioName, QString& overlayName, bool saveToZip) const;

      virtual bool saveGuiSettings(const QString& scenarioname, QString& guiSettingsName, bool saveToZip) const;

      virtual bool saveObserverViews(const QString& scenarioname, QString& observerSettingsName, bool saveToZip) const;

   protected:
      makVrv::DtDe&  myDe;
      mutable QString        myStartingDirectory;
      mutable DtScenario*    myScenario;
      double         myRootSaveSimTime;
      std::string    myDefaultObserverView;
      std::string    myCheckpointIdentifier;
      bool           myRootSaveTimeSet;
      bool           mySaving;
   };
}