scenarioDescriptionImporterExporter.h

Go to the documentation of this file.

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


#pragma once

#include "vrfutil/vrfutilDefines.h"
#include "vrfutil/scenario.h"
#include "vrfutil/msdlHierarchyPropertyMappings.h"

#include <string>
#include <map>

class DtFilename;
class DtSimManager;

class DT_DLL_vrfutil DtScenarioDescriptionImporterExporter
{
public:
   DtScenarioDescriptionImporterExporter() {};

   virtual ~DtScenarioDescriptionImporterExporter() {};

   virtual bool loadScenarioDescription(const DtFilename& file,
      const std::map<std::string, std::string>& importData, const DtMsdlHierarchyPropertyMappings&) = 0;

   const DtScenario& scenario() const
   {
      return myScenario;
   }

   const std::string& error() const
   {
      return myError;
   }

   virtual DtScenarioDescriptionImporterExporter* clone() = 0;

   virtual bool importIntoSimulation(DtSimManager*) = 0;

   virtual bool importFromSimulation(DtSimManager*,
      const std::map<std::string, std::string>& exportData, const DtMsdlHierarchyPropertyMappings&) = 0;

   virtual bool saveScenarioDescription(const DtFilename& file, const DtScenario&) const = 0;

   virtual std::string supportedExtensions() = 0;

   virtual bool canImportFile(const DtFilename&) = 0;

   virtual bool complete() const
   {
      return true;
   }

protected:
   DtScenario myScenario;
   mutable std::string myError;
};