Importing/Exporting Scenarios from Different File Formats example

The Importing/Exporting Scenarios from Different File Formats example demonstrates the following:

• How to add a scenario importer/exporter to the back-end
• How to import a scenario file of comma delimited format
• How to export a scenario into a comma delimited format
• How to write a front-end example that works in conjuction with a back-end example

The Importing/Exporting scenarios example installes a new scenario importer/exporter that will read a comma delimited file and restore entity/aggregate laydown as well as tactical graphic objects.

Since this example is loaded as a plugin, it can be used in conjunction with the released VR-Forces application. Make sure to enable the csvScenarioImporterExporter example from the launcher application

Usage

Select Settings, Plugins... and on the Plugins Editor page, use the combo box at the top of the page to select the plug-in. Then enable the Load

To view the new behavior:

1. Load Scenario...
2. Export Scenario... selecting CSV format
3. New Scenario...
4. Import Scenario... selecting file just exported to verify that objects were exported correctly

Notes

Scenario Import/Export does not export VR Forces specific data, such as Plans and Tasks.

Classes

DtVrfCSVScenarioDescriptionImporterExporter	Class that will import/export information to/from the scenario. Extension of DtCSVScenarioDescriptionImporterExporter.
DtCSVScenarioDescriptionImporterExporter	Class that will fill in internal structures with information from a comma delimited file or write the comma delimited file from scenario information.

---

Plugin Entry Points

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

//VR-Forces includes
#include "vrfcgf/vrfPluginExtension.h"
#include "vrfcgf/cgf.h"

#include "vrfobjcore/importExportScenarioDescriptionManager.h"
#include "vrfCSVScenarioDescriptionImporterExporter.h"

extern "C" {

   DT_VRF_DLL_PLUGIN void DtPluginInformation(DtVrfPluginInformation& info)
   {
      info.pluginName = "csvScenarioImporterExporterSim";
      info.pluginDescription = "An example of how to take a scenario imported from a file and incorporate it into an existing scenario";
      info.pluginVersion = "1.00";
      info.pluginCreator = "MAK Technologies";
      info.pluginCreatorEmail = "sales@mak.com";
      info.pluginContactWebPage = "www.mak.com";
      info.pluginContactMailingAddress = "150 Cambridge Park Drive 3rd Floor - Cambridge, MA 02140 USA";
      info.pluginContactPhone = "(617) 876 8085";
   }

   DT_VRF_DLL_PLUGIN bool DtPostInitializeVrfPlugin(DtCgf* cgf)
   {
      cgf->importExportScenarioDescriptionManager()->addScenarioDescriptionImporter("csv",
         new DtVrfCSVScenarioDescriptionImporterExporter);

      return true;
   }
}

Header

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


#pragma once

#include <vrfGuiCoreQt/DtVrfGuiScenarioDescriptionImporterExporter.h>


class DtCSVScenarioImporterExporterGui : public makVrf::DtVrfGuiScenarioDescriptionImporterExporter
{
public:
   DtCSVScenarioImporterExporterGui(makVrv::DtDe& de);

   virtual ~DtCSVScenarioImporterExporterGui();

   virtual void importScenario(const DtFilename&);

   virtual void exportScenario(const DtFilename&);

   virtual std::string supportedExtensions();

   virtual bool canImportFile(const DtFilename&);

   virtual DtScenarioDescriptionImporterExporter* importerExporter();
};

Class

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


#include "csvScenarioImporterExporterGui.h"
#include "../csvScenarioImporterExporterSim/csvScenarioDescriptionImporterExporter.h"
#include <vrvCore/DtDe.h>
#include <vrfGuiCore/DtGuiThreadVrfRemoteController.h>
#include <vrfGuiCore/DtVrfSimBackEndManager.h>

using namespace makVrv;
using namespace makVrf;

DtCSVScenarioImporterExporterGui::DtCSVScenarioImporterExporterGui(DtDe& de)
: DtVrfGuiScenarioDescriptionImporterExporter(de)
{
}

DtCSVScenarioImporterExporterGui::~DtCSVScenarioImporterExporterGui()
{
}

void DtCSVScenarioImporterExporterGui::importScenario(const DtFilename& file)
{
   std::map<std::string, std::string> importData;

   DtGuiThreadVrfRemoteController::instance(myDe).importScenarioDescriptionFile(file.c_str(),
      DtVrfSimBackendManager::instance(myDe).selectedBackend(), "csv", importData);
}

void DtCSVScenarioImporterExporterGui::exportScenario(const DtFilename& file)
{
   std::map<std::string, std::string> exportData;

   DtGuiThreadVrfRemoteController::instance(myDe).exportScenarioDescriptionFile(file.c_str(),
      DtVrfSimBackendManager::instance(myDe).selectedBackend(), "csv", exportData);
}

std::string DtCSVScenarioImporterExporterGui::supportedExtensions()
{
   DtScenarioDescriptionImporterExporter* imp = importerExporter();

   std::string supported = imp->supportedExtensions();

   delete imp;

   return supported;
}

bool DtCSVScenarioImporterExporterGui::canImportFile(const DtFilename& f)
{
   DtScenarioDescriptionImporterExporter* imp = importerExporter();

   bool canImport = imp->canImportFile(f);

   delete imp;

   return canImport;
}

DtScenarioDescriptionImporterExporter* DtCSVScenarioImporterExporterGui::importerExporter()
{
   return new DtCSVScenarioDescriptionImporterExporter;
}