DtSharedCigiSettings.h

Go to the documentation of this file.

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


#pragma once

#include <vrvCigi/vrvCigi.h>
#include <vrvCore/DtSharedSettings.h>
#include <vrvCore/DtSettingsBackup.h>

#include <makArchives/DtCigiSettingsRecord.h>

#include <string>
#include <map>

namespace makVrv
{
   class DtCigiSettingsBackup;

   class DT_DLL_VRVCIGI DtSharedCigiSettings : public DtSharedSettings
   {
   public:
      typedef std::pair<makArchives::DtCigiSettingsRecord*, DtCigiSettingsBackup*>  DtCigiSettingsPair;
      typedef std::map<std::string, DtCigiSettingsPair> StringToSettingsMap;

      friend class DtReadSettingsLock<DtSharedCigiSettings>;
      friend class DtWriteSettingsLock<DtSharedCigiSettings>;
      friend class DtSharedSettingsManager;

      static std::string className();

      virtual ~DtSharedCigiSettings();

      virtual void addCigiSettings( const std::string& settingsName );

      virtual void setCigiSettings( const std::string& settingsName,
         const makArchives::DtCigiSettingsRecord& record );

      virtual void removeCigiSettings( const std::string& settingsName );

      virtual void setCurrentSettingsName( const std::string& settingsName );

      virtual const makArchives::DtCigiSettingsRecord* currentSettings() const;

      virtual const std::string& currentSettingsName() const;

      virtual makArchives::DtCigiSettingsRecord* findCigiSettingsByName(
         const std::string& settingsName );

      virtual const makArchives::DtCigiSettingsRecord* findCigiSettingsByName(
         const std::string& settingsName ) const;

      virtual bool definitionInUse( const std::string& def ) const;

      virtual const std::string& mapEntityModelDefinition( int entType ) const;

      virtual const std::string& mapEntityModelSchemaName( int entType ) const;

      virtual StringToSettingsMap::const_iterator begin() const;
      virtual StringToSettingsMap::const_iterator end() const;

      virtual unsigned int settingsCount() const;

      virtual const std::string& findDatabaseFilename( int databaseNumber );

      virtual const std::string& findAnimationName( int animationId );

      virtual const std::string& findActiveRegionName( int regionId );

      virtual const std::string& findLightPointGroupName( int groupId );

      virtual const std::string& findSensorName( int sensorId );

      virtual const std::vector<std::string>& componentStrings(
         makArchives::DtCigiComponentClass compClass ) const;

      virtual const DtSettingsBackup* settingsBackup( const std::string& name ) const;
      virtual DtSettingsBackup* settingsBackup( const std::string& name );

   public:
      virtual void addModelStateMapping( int cigiId, int stateId );

      virtual void removeModelStateMapping( int cigiId );

      virtual void setArtPartMapping( int entType, int cigiId, int disId );

      virtual void removeArtPartMapping( int entType, int cigiId );

      virtual void addDatabaseMapping( int databaseNumber, const std::string& filename );

      virtual void removeDatabaseMapping( int databaseNumber );

      virtual void addObserverModeMapping( int observerNumber, const std::string& filename );

      virtual void removeObserverModeMapping( int observerNumber );

      virtual void addComponentIdMapping( makArchives::DtCigiComponentClass compClass,
         int compId, const std::string& compName );

      virtual void removeComponentIdMapping( makArchives::DtCigiComponentClass compClass,
         int compId );

      virtual void addAnimationMapping( int animationId, const std::string& animationName );

      virtual void removeAnimationMapping( int animationId );

      virtual void addActiveRegionMapping( int regionId, const std::string& regionName );

      virtual void removeActiveRegionMapping( int regionId );

      virtual void addLightPointGroupMapping( int groupId, const std::string& groupName );

      virtual void removeLightPointGroupMapping( int groupId );

      virtual void addSensorMapping( int sensorId, const std::string& sensorName );

      virtual void removeSensorMapping( int sensorId );

   public:

      virtual void setEntityTypeModelMapping( int entType,
         const std::string& modelName, const std::string& schemaName );

      virtual void removeEntityTypeModelMapping( int entType );

      virtual bool remapEntityType( int oldType, int newType );

      virtual bool renameModelDefinition( const std::string& oldName, const std::string& newName, std::vector<std::string>& mappersChanged );

   protected:

      DtSharedCigiSettings( DtSharedSettingsManager& manager );

   protected:
      std::string myEmptyMapping;

      StringToSettingsMap                          mySettingsByName;
      std::string                                  myCurrentSettingsName;
      makArchives::DtCigiSettingsRecord*           myCurrentSettings;
      std::vector<std::string>                     myEntityComponentStrings;
      std::vector<std::string>                     myViewComponentStrings;
      std::vector<std::string>                     mySystemComponentStrings;
      std::vector<std::string>                     myRegionalSeaSurfaceComponentStrings;
      std::vector<std::string>                     myGlobalTerrainSurfaceComponent;
   };
   
   class DT_DLL_VRVCIGI DtCigiSettingsBackup : public DtSettingsBackup
   {
   public:
      DtCigiSettingsBackup(makArchives::DtCigiSettingsRecord*, const std::string& name);

      virtual ~DtCigiSettingsBackup();

      const makArchives::DtCigiSettingsRecord& restoredCigiSettings() const
      {
         return myRestoredCigiSettings;
      }

      const makArchives::DtCigiSettingsRecord* cigiSettings() const
      {
         return myCigiSettings;
      }

      void setCigiSettings(makArchives::DtCigiSettingsRecord* r)
      {
         myCigiSettings = r;
      }

   protected:
      virtual void restore(const DtSettingsBackup* from);

      virtual std::string backupClassType() const;

      virtual DtSettingsBackup* create() const;

      virtual void write(boost::archive::xml_oarchive& ar);

      virtual void read(boost::archive::xml_iarchive& ar);

      virtual std::string backupName() const;

   protected:
      makArchives::DtCigiSettingsRecord*  myCigiSettings;
      makArchives::DtCigiSettingsRecord   myRestoredCigiSettings;
      std::string                         myName;
   };
}