DtSharedSimulationSettingsManager.h

Go to the documentation of this file.

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


#pragma once

#include <vrvVrl/vrvVrl.h>

#include <vrvUtil/DtVirtualBaseClass.h>

#include <vrvVrl/DtSharedSimulationSettings.h>
#include <vrvUtil/DtSignalConnectionManager.h>
#include <vrvCore/DtSettingsChangeManager.h>

namespace makArchives
{
   class DtEntityTypeMappingRecord;
}

namespace makVrv
{

   class DtSettingsBackup;
   class DtEntityTypeMapper;
   class DtDeSettings;

   class DT_DLL_VRVVRL DtSharedSimulationSettingsManager
      : public DtVirtualBaseClass
   {
   public:

      static DtSharedSimulationSettingsManager& instance( DtDe& de );

      virtual ~DtSharedSimulationSettingsManager();

      void connectInputSignals();

      void loadDefaultMappings( DtEntityTypeMapper& mapper, bool useFactory );

      void saveDefaultMappings();

      void saveDefaultMappings( const DtEntityTypeMapper& mapper );

      void loadMapFile( const std::string& filePath, DtEntityTypeMapper& mapper );

      void mergeMapFile(const std::string& filePath, DtEntityTypeMapper& mapper);

      void saveMapFile( const std::string& filePath,
         const DtEntityTypeMapper& mapper );

      void saveSelectedMapFile(const std::string& filePath,std::vector<std::string>& keys,
         const DtEntityTypeMapper& mapper);

      bool shouldLoadDefaultMappings(const DtDeSettings* setting);

      bool shouldMergeMappings(const DtDeSettings* setting);
      
      // Get list of files to merge when using the command line
      // --merge{Entity,Aggregate,TacticalGraphics}TypeMap 
      const std::vector<std::string> getFilesToMerge(const DtDeSettings* setting);

      // Check that type map should end with 'TypeMap'
      // (helps with generating where to look for type maps in the definitions)
      bool hasTypeMapSuffix(DtDeSettings* settings);

      void setAutoSave( bool b );

      bool autoSave() const;

   protected:

      virtual void mapperChanged( const DtEntityTypeMapper& );

      virtual void backupMapper( DtEntityTypeMapper& );

      virtual void entityTypeMappingsRestored( const DtSettingsBackup* );

      virtual bool mergeTypeMappings(const std::string& dir);

      virtual bool mergeTypeMappingFile(const std::string& fileName);

      virtual bool mergeTypeMappingsFromPath(
         makArchives::DtEntityTypeMappingRecord &record,
         DtDeSettings* settings, const std::string& fileOrDir);

      std::string generateDefaultDir(DtDeSettings* settings);

      void generateDefaultDirAndFiles(DtDeSettings* settings,
         std::string& defaultDir, std::vector<std::string>& defaultDirFiles);

      std::string generateFactoryDir(DtDeSettings* settings);

      void generateFactoryDirAndFiles(DtDeSettings* settings,
         std::string& factoryDir, std::vector<std::string>& factoryDirFiles);

      DtSharedSimulationSettingsManager( DtDe& de );

   private:

      void initializeMappings();

      void initDefaultMappings( bool useFactory );

   private:

      DtSignalConnectionManager myConnections;

      bool myAutoSave;

      std::string myTypeMapSuffix;

      DtDe& myDe;

   };

}