include/vrfutil/scenarioExplorer.h

Go to the documentation of this file.

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


#pragma once

#include "vrfutil/scenario.h"
#include "vrfutil/simulationModelSet.h"

#include <vector>


#include "vrfutil/vrfutilDefines.h"
class DT_DLL_vrfutil DtScenarioExplorer
{
public:

   DtScenarioExplorer();

   DtScenarioExplorer(const DtScenario& scenario);

   virtual ~DtScenarioExplorer();

   DtScenarioExplorer(const DtScenarioExplorer& orig);

   DtScenarioExplorer& operator=(const DtScenarioExplorer& orig);


   virtual bool init();

   virtual bool readScenarioFile(const DtFilename& filename);

   virtual DtFilename terrainDatabaseFilename() const;

   virtual DtFilename componentAttachmentTableFilename() const;
   virtual DtFilename orderOfBattleFilename() const;

   virtual DtFilename planFilename() const;


   virtual DtFilename globalPlanFilename() const;

   virtual DtFilename parameterDatabaseFilename() const;

   virtual DtFilename forceHostilityFilename() const;

   virtual DtFilename scenarioExtrasFilename() const;

   virtual const std::vector<DtFilename>& physicalWorldFilenames() const;

   virtual const std::vector<DtFilename>& indirectArtilleryTypesFilenames() const;

   virtual const std::vector<DtFilename>& commModelFilenames() const;

   virtual DtFilename objectMapFilename() const;

   virtual DtReal timeMultiplier() const;

   virtual bool autoReorganize() const;

   virtual unsigned randomNumberSeed() const;

   virtual DtString frameRateModeString() const;
   virtual DtFrameMode frameRateMode() const;

   virtual DtReal frameDeltaTime() const;

   virtual DtTime runDurationTime();

   virtual DtTime simTime() const;

   virtual DtTime exerciseStartTime() const;

   virtual const std::vector<DtFilename>& additionalOpdFilenames() const;

   virtual DtRwNLengthStringVector simulationModelSetFilenames();

   virtual DtFilename filename() const;

   virtual bool isValid(bool allowEmptyFilenames = true) const;

   virtual double version() const;

   virtual void processModelSets();

   virtual void loadCoreModelSets();

public:

   virtual const std::vector<DtFilename>& symbolMapFilenames() const;

   virtual std::vector<DtString> symbolMapLabels() const;

   virtual const std::vector<DtFilename>& createMenuFilenames() const;

   virtual const std::vector<DtFilename>& threeDSymbolMaps() const;

   virtual const std::vector<DtFilename>& overlayMenuFilenames() const;

   std::vector<DtSimulationModelSet*>&  modelSets();
   const std::vector<DtSimulationModelSet*>&  modelSets() const;

   virtual const std::vector<DtFilename>& modelSetForceFilenames() const;

   virtual const std::vector<DtFilename>& modelSetFilenames() const;

   virtual void gatherSymbolMapInforation();

   virtual DtString symbolMapName(const DtString& symbolMap) const;
   virtual void addFilename(std::vector<DtFilename>&, const DtFilename& map) const;
   
   virtual void setSymbolMapName(const DtString&);

   virtual std::vector<DtFilename> symbolMapsFor(const DtString& symbolMap, bool includeOverlay = true) const;

   DtScenario* scenario() const;

protected:
   virtual void clearModelSets();
   virtual void mergeAdditionalOpdFiles();
   virtual void processModelSet(DtSimulationModelSet*);

protected:
   DtScenario*                         myScenario;
   DtFilename                          myParameterDatabaseFilename;
   DtFilename                          myForceHostilityFilename;
   DtFilename                          myScenarioExtrasFilename;
   std::vector<DtSimulationModelSet*>  myModelSets;
   std::vector<DtFilename>             myPhysicalWorldFilenames;
   std::vector<DtFilename>             myIndirectArtilleryTypesFilenames;
   std::vector<DtFilename>             myAdditionalOpdFilenames;
   std::vector<DtFilename>             myCommModelFilenames;

   std::vector<DtFilename>             mySymbolMapFilenames;
   std::vector<DtFilename>             myCreateMenuFilenames;
   std::vector<DtFilename>             my3DSymbolMapFilenames;
   std::vector<DtFilename>             myOverlayMenuFilenames;
   std::vector<DtFilename>             myModelSetForceFilenames;
   std::vector<DtFilename>             myModelSetFilenames;
};

inline std::vector<DtSimulationModelSet*>&  DtScenarioExplorer::modelSets(){return (myModelSets);}
inline const std::vector<DtSimulationModelSet*>&  DtScenarioExplorer::modelSets() const{return (myModelSets);}
inline DtScenario* DtScenarioExplorer::scenario() const
{
   return myScenario;
}