vrfConfigurationFileComposer.h

Go to the documentation of this file.

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


#pragma once

#include <vlutil/vlFilename.h>
#include <vlutil/vlHashlist.h>
#include <vlutil/vlHashKeys.h>
#include <vlutil/vlList.h>
#include <vl/hostStructs.h>
#include "vrfutil/addressMap.h"
#include "vrfcontrol/vrfFileParser.h"
#include "vrfutil/scenario.h"
#include "vrfutil/backendMap.h"


#include "vrfcontrol/vrfcontrolDefines.h"
class DT_DLL_vrfcontrol DtVrfConfigurationFileComposer
{
public:

   DtVrfConfigurationFileComposer();

   virtual ~DtVrfConfigurationFileComposer();

   virtual bool init();
   
   virtual bool readObjectMap(DtFilename objectMap);   

   virtual std::set<DtSimulationAddress> scenarioBackends() const;

   virtual DtBackendMap* backendMap();
   
   virtual DtAddressMap* objectMap();
   
   virtual bool composeOrderOfBattleFile(
      const DtFilename& targetFileName, const DtList& files, DtString& sError);
   
   virtual bool composeScenarioScriptsFile(
      const DtFilename& targetFileName, const DtString& files);

   virtual bool composePlanFile(
      const DtFilename& targetFileName, const DtList& files);

   virtual bool composeHostilityFile(
      const DtFilename& targetFileName, const DtList& files);

   virtual bool composeScenarioExtrasFile(
      const DtFilename& targetFileName, const DtList& files);
 

   virtual bool createMapFile(
      const DtFilename& targetFileName, 
      const DtList& simAddresses, const DtList& oobFiles,
      const DtList& planFiles,
      bool preserveMappings = true);

   std::vector<DtFilename>& customComponentAttachmentFilenames();
   const std::vector<DtFilename>& customComponentAttachmentFilenames() const;
   virtual bool decompose(const DtFilename& orderOfBattle, 
      const DtFilename& plan, const DtFilename& globalPlan, bool& hasGlobalWeatherObject);

   virtual bool decomposeScenarioScriptsFile(const DtFilename&);

   virtual bool decomposeComponentAttachmentFile(const DtFilename& originalFile,
      unsigned numBackends);

   virtual DtFilename* getOrderOfBattleFile(
      const DtSimulationAddress& addr) const;
   virtual DtFilename* getScenarioScriptsFile(const DtSimulationAddress& addr) const;
   virtual DtFilename* getPlanFile(
      const DtSimulationAddress& addr) const;
   virtual DtFilename* getGlobalPlanFile(const DtSimulationAddress& addr) const;

   virtual const DtFilename& getComponentAttachmentFile(unsigned idx) const;

   virtual const DtFilename& tempDirectory();
   virtual void setTempDirectory(const DtFilename& f);

   virtual void setFilePrefix(const DtString&);
   virtual const DtString& filePrefix() const;

protected:

   virtual void clear();
   virtual bool createBackendFiles(
      const DtFilename& origFileName, 
      DtHashList& createdFiles, const char* prefix = "(\n", bool* hasGlobalWeatherObject = 0);

   virtual bool composePlanFileBody(FILE* fp, const DtList& files);

   virtual bool fastProcess(const DtFilename& fullname, FILE* fp, int& size);

protected:
   DtBackendMap* myBackendMap;
   DtAddressMap* myObjectMap;
   DtAddressMap* myOriginalObjectMap;
   DtVrfFileParser myParser;
   DtHashlist myAddr2FileMap;
   DtHashlist myCreatedPlnFiles;
   DtHashlist myCreatedOobFiles;
   DtHashlist myCreatedGlobalPlanFiles;
   DtHashlist myCreatedHostilityFiles;
   std::vector<DtFilename> myCreatedComponentAttachmentFiles;
   DtFilename myTempDirectory;
   DtList myRequiredBackendAddrs;
   DtFilename* myScenarioScriptsFile;
   DtString myFilePrefix;

   static const char theUnknownMappingName[];
};

inline std::vector<DtFilename>& DtVrfConfigurationFileComposer::customComponentAttachmentFilenames()
{
   return (myCreatedComponentAttachmentFiles);
}

inline const std::vector<DtFilename>& DtVrfConfigurationFileComposer::customComponentAttachmentFilenames() const
{
   return (myCreatedComponentAttachmentFiles);
}