simulationModelSet.h

Go to the documentation of this file.

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


#pragma once

#include <readerWriter/readerWriter.h>
#include "vrfutil/rwTemplatedList.h"
#include <readerWriter/rwString.h>
#include <readerWriter/rwBoolean.h>
#include "vrfutil/rwNLengthStringVector.h"
#include <readerWriter/readerWriterFile.h>

#include <vlutil/vlFilename.h>
#include "vrfutil/vrfutilDefines.h"

typedef DtRwTemplatedListPtr<DtRwString, true> DtComponentAttachmentList;

class DT_DLL_vrfutil DtSimulationModelSet : public DtReaderWriter
{
public:

   DtSimulationModelSet();

   DtSimulationModelSet(const DtString& name, DtReaderWriterRegistry*  
      parentRegistry = NULL);

   virtual ~DtSimulationModelSet() override;

   DtSimulationModelSet(const DtSimulationModelSet& orig, 
      DtReaderWriterRegistry*  parentRegistry = NULL);

   DtSimulationModelSet& operator=(const DtSimulationModelSet& orig);

   virtual bool load(const DtFilename&);

   virtual bool save(const DtFilename&, bool rebind = true);

   virtual bool save(bool rebind = true);

   const DtFilename& path() const;

   virtual void updateVersion();

   int version() const;
   virtual bool passesVersionTest() const;


   const DtFilename& opdFile() const;
   void setOpdFile(const DtFilename&);


   const DtFilename& physicalWorldFile() const;
   void setPhysicalWorldFile(const DtFilename&);


   const DtFilename& detonationParametersFile() const;
   void setDetonationParametersFile(const DtFilename&);


   const DtFilename& enumerationsFile() const;
   void setEnumerationsFile(const DtFilename&);


   const DtFilename& detonationTerrainDeformParametersFile() const;
   void setdetonationTerrainDeformParametersFile(const DtFilename&);


   const DtFilename& ammunitionParametersFile() const;
   void setAmmunitionParametersFile(const DtFilename&);


   const DtFilename& indirectArtilleryTypesFile() const;
   void setIndirectArtilleryTypesFile(const DtFilename&);
   

   const DtFilename& commModelParameters() const;
   void setCommModelParameters(const DtFilename&);


   const DtString& comment() const;
   void setComment(const DtString&);


   const DtString& simulationObjectGroupConnection() const;
   void setSimulationObjectGroupConnection(const DtString&);


   virtual DtFilename defaultComponentAttachmentFile() const;
   const DtFilename& filename() const;
   virtual void setFilename(const DtFilename&);

   DtSimulationModelSet* clone() const;

   virtual DtFilename modelSetDirectory() const;

   virtual bool setModelSetDirectory(const DtFilename&);


   DtComponentAttachmentList& componentAttachmentFileList();
   const DtComponentAttachmentList& componentAttachmentFileList() const;


   bool preloadParameters() const;
   void setPreloadParameters(bool);

   virtual void setVisualDataInSharedData(bool);
   virtual bool visualDataInSharedData() const;

   virtual void setReadOnly(bool);
   virtual bool readOnly() const;


   DtFilename getDataDirectory(bool warnOnFailure = true) const;

   DtFilename getGuiDirectory(bool warnOnFailure = true) const;

   DtFilename getExtrasDirectory() const;

   DtFilename getVisualsDirectory(bool warnOnFailure = true) const;

   DtFilename getRecycleBin(bool warnOnFailure = true) const;

   DtFilename getRootDirectory(bool warnOnFailure = true) const;
   DtFilename getScriptedMovementDirectory(bool warnOnFailure = true) const;
   DtFilename getUIDirectory(bool warnOnFailure = true) const;

   DtFilename getSystemDirectory(bool warnOnFailure = true) const;
   DtFilename getParametersDirectory(bool warnOnFailure = true) const;
   DtFilename getAmmoSelectDirectory(bool warnOnFailure = true) const;
   DtFilename getNavDataDirectory(bool warnOnFailure = true) const;
   DtFilename getHitDirectory(bool warnOnFailure = true) const;
   DtFilename getDamageDirectory(bool warnOnFailure = true) const;
   DtFilename getDetectionDirectory(bool warnOnFailure = true) const;
   DtFilename getFormationDirectory(bool warnOnFailure = true) const;
   DtFilename getObjectGroupsDirectory(bool warnOnFailure = false) const;

   const DtRwVariableBindings* originalVariableBindings() const
   {
      return myOriginalVariableBindings;
   }

   DtRwVariableBindings* originalVariableBindings()
   {
      return myOriginalVariableBindings;
   }

   virtual void setValidatorString(const DtString&);
   virtual const DtString& validatorString() const;

   virtual void setRequiredSimPlugins(const DtString&);
   virtual const std::vector<DtString>& requiredSimProtocolIndependentPlugins() const;
   virtual const std::vector<DtString>& requiredSimDisPlugins() const;
   virtual const std::vector<DtString>& requiredSimHla1516ePlugins() const;
   virtual const std::vector<DtString>& requiredSimHla4Plugins() const;

   virtual void setRequiredGuiPlugins(const DtString&);
   virtual const std::vector<DtString>& requiredGuiProtocolIndependentPlugins() const;
   virtual const std::vector<DtString>& requiredGuiDisPlugins() const;
   virtual const std::vector<DtString>& requiredGuiHla1516ePlugins() const;
   virtual const std::vector<DtString>& requiredGuiHla4Plugins() const;

   virtual void saveVariableBindingsToOpdFile();

   const DtFilename& hostilityFile() const;
   void setHostilityFile(const DtFilename& s);

   const DtFilename& scenarioDataFile() const;
   void setScenarioDataFile(const DtFilename& n);


   virtual std::vector<DtString> includedSMSs() const;
   virtual void setIncludedSMSs(std::vector<DtString> smss);


   virtual DtString shortName() const;
   virtual void setShortName(DtString&);


   virtual DtReaderWriter::SearchPaths searchPaths() const;
   virtual void addSearchPaths(const DtReaderWriter::SearchPaths& searchPaths);
   virtual void clearSearchPaths();

protected:
   virtual DtString createSubstitutedPath(const DtFilename&, const DtString& modelSetDir);
   virtual void setupVariableSubstitutedPaths();
   virtual void substituteVariablePaths();
   virtual void resetVariables();

   virtual void placeOpdVariablesIntoVariableBindings();

   virtual DtReaderWriter* readOpdFile() const;

   virtual void substituteInVariables(const DtString& variable);

protected:
   DtRwString     myOpdFile;
   DtRwString     myPhysicalWorldFile;
   DtRwString     myEnumerationsFile;
   DtRwString     myDetonationParametersFile;
   DtRwString     myDetonationTerrainDeformParametersFile;
   DtRwString     myAmmunitionParametersFile;
   DtRwString     myIndirectArtilleryTypesFile;
   DtRwString     myCommModelParameters;
   DtRwString     myHostilityFile;
   DtRwString     myScenarioDataFile;
   DtRwString     myIncludedSMSs;
   DtRwString     myValidatorString;
   DtRwString     mySimulationObjectGroupConnection;
   DtRwBoolean    myPreloadParameters;
   DtFilename     myPath;
   DtFilename     myFilename;
   DtString       myComment;
   DtRwBoolean    myVisualDataInSharedData;
   DtRwBoolean    myReadOnly;
   DtRwString     myShortname;
   DtRwString     myRequiredSimPlugins;
   DtRwString     myRequiredSimDisPlugins;
   DtRwString     myRequiredSimHla1516ePlugins;
   DtRwString     myRequiredSimHla4Plugins;
   DtRwString     myRequiredGuiPlugins;
   DtRwString     myRequiredGuiDisPlugins;
   DtRwString     myRequiredGuiHla1516ePlugins;
   DtRwString     myRequiredGuiHla4Plugins;

   mutable std::vector<DtString> myRequiredSimPluginsList;
   mutable std::vector<DtString> myRequiredSimDisPluginsList;
   mutable std::vector<DtString> myRequiredSimHla1516ePluginsList;
   mutable std::vector<DtString> myRequiredSimHla4PluginsList;
   mutable std::vector<DtString> myRequiredGuiPluginsList;
   mutable std::vector<DtString> myRequiredGuiDisPluginsList;
   mutable std::vector<DtString> myRequiredGuiHla1516ePluginsList;
   mutable std::vector<DtString> myRequiredGuiHla4PluginsList;

   DtFilename     mySubOpdFile;
   DtFilename     mySubPhysicalWorldFile;
   DtFilename     mySubDetonationParametersFile;
   DtFilename     mySubEnumerationsFile;
   DtFilename     mySubDetonationTerrainDeformParametersFile;
   DtFilename     mySubAmmunitionParametersFile;
   DtFilename     mySubIndirectArtilleryTypesFile;
   DtFilename     mySubCommModelParameters;
   DtFilename     mySubHostilityFile;
   DtFilename     mySubScenarioDataFile;
   DtComponentAttachmentList myComponentAttachmentFileList;

   DtRwVariableBindings* myOriginalVariableBindings;

   DtReaderWriter::SearchPaths mySearchPaths;

   DtRwInt myVersion;
};

inline int DtSimulationModelSet::version() const
{
   return myVersion;
}

inline void DtSimulationModelSet::setPhysicalWorldFile(const DtFilename& f)
{
   mySubPhysicalWorldFile = f;
}

inline const DtFilename& DtSimulationModelSet::physicalWorldFile() const
{
   return mySubPhysicalWorldFile;
}

inline void DtSimulationModelSet::setDetonationParametersFile(const DtFilename& f)
{
   if (DtString(f).findChar('$') == 0)
   {
      myDetonationParametersFile.setUnsubstitutedString(f);
   }

   mySubDetonationParametersFile = f;
}

inline const DtFilename& DtSimulationModelSet::detonationParametersFile() const
{
   return mySubDetonationParametersFile;
}

inline void DtSimulationModelSet::setEnumerationsFile(const DtFilename& f)
{
   if (DtString(f).findChar('$') == 0)
   {
      myEnumerationsFile.setUnsubstitutedString(f);
   }

   mySubEnumerationsFile = f;
}

inline const DtFilename& DtSimulationModelSet::enumerationsFile() const
{
   return mySubEnumerationsFile;
}

inline void DtSimulationModelSet::setdetonationTerrainDeformParametersFile(const DtFilename& f)
{
   if (DtString(f).findChar('$') == 0)
   {
      myDetonationTerrainDeformParametersFile.setUnsubstitutedString(f);
   }

   mySubDetonationTerrainDeformParametersFile = f;
}

inline const DtFilename& DtSimulationModelSet::detonationTerrainDeformParametersFile() const
{
   return mySubDetonationTerrainDeformParametersFile;
}

inline void DtSimulationModelSet::setAmmunitionParametersFile(const DtFilename& f)
{
   if (DtString(f).findChar('$') == 0)
   {
      myAmmunitionParametersFile.setUnsubstitutedString(f);
   }

   mySubAmmunitionParametersFile = f;
}

inline const DtFilename& DtSimulationModelSet::ammunitionParametersFile() const
{
   return mySubAmmunitionParametersFile;
}

inline void DtSimulationModelSet::setIndirectArtilleryTypesFile(const DtFilename& f)
{
   mySubIndirectArtilleryTypesFile = f;
}

inline const DtFilename& DtSimulationModelSet::indirectArtilleryTypesFile() const
{
   return mySubIndirectArtilleryTypesFile;
}

inline const DtFilename& DtSimulationModelSet::opdFile() const
{
   return mySubOpdFile;
}

inline void DtSimulationModelSet::setOpdFile(const DtFilename& f)
{
   mySubOpdFile = f;
}

inline const DtFilename& DtSimulationModelSet::commModelParameters() const
{
   return mySubCommModelParameters;
}

inline void DtSimulationModelSet::setCommModelParameters(const DtFilename& f)
{
   mySubCommModelParameters = f;
}

inline DtComponentAttachmentList& DtSimulationModelSet::componentAttachmentFileList()
{
   return (myComponentAttachmentFileList);
}

inline const DtComponentAttachmentList& DtSimulationModelSet::componentAttachmentFileList() const
{
   return (myComponentAttachmentFileList);
}

inline const DtFilename& DtSimulationModelSet::filename() const
{
   return myFilename;
}

inline void DtSimulationModelSet::setFilename(const DtFilename& f)
{
   myFilename = f;
}

inline const DtString& DtSimulationModelSet::comment() const
{
   return myComment;
}

inline void DtSimulationModelSet::setComment(const DtString& c)
{
   myComment = c;
}

inline bool DtSimulationModelSet::preloadParameters() const
{
   return myPreloadParameters;
}

inline void DtSimulationModelSet::setPreloadParameters(bool b)
{
   myPreloadParameters = b;
}

inline const DtFilename& DtSimulationModelSet::path() const
{
   return myPath;
}

inline const DtFilename& DtSimulationModelSet::hostilityFile() const
{
   return mySubHostilityFile;
}

inline void DtSimulationModelSet::setHostilityFile(const DtFilename& s)
{
   mySubHostilityFile=s;
}

inline const DtFilename& DtSimulationModelSet::scenarioDataFile() const
{
   return mySubScenarioDataFile;
}

inline void DtSimulationModelSet::setScenarioDataFile(const DtFilename& s)
{
   mySubScenarioDataFile=s;
}

inline const DtString& DtSimulationModelSet::validatorString() const
{
   return myValidatorString;
}

inline void DtSimulationModelSet::setValidatorString(const DtString& s)
{
   myValidatorString=s;
}

inline void DtSimulationModelSet::setRequiredSimPlugins(const DtString& s)
{
   myRequiredSimPlugins = s;
   myRequiredSimPluginsList.clear();
}

inline void DtSimulationModelSet::setRequiredGuiPlugins(const DtString& s)
{
   myRequiredGuiPlugins = s;
   myRequiredGuiPluginsList.clear();
}

inline const DtString& DtSimulationModelSet::simulationObjectGroupConnection() const
{
   return mySimulationObjectGroupConnection;
}

inline void DtSimulationModelSet::setSimulationObjectGroupConnection(const DtString& s)
{
   mySimulationObjectGroupConnection=s;
}