include/vrfutil/scenarioMergeDirector.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/scenarioMergeData.h"

class DtScenarioMergeProject;
class DtFilename;
class DtlObjPtr;

class DT_DLL_vrfutil DtScenarioMergeDirector
{
public:

   enum FileType
   {
      FILE_NONE = 0,
      FILE_GPL,
      FILE_OMP,
      FILE_OOB,
      FILE_OVL,
      FILE_PLN,
      FILE_SGR,
      FILE_XTR 
   };

public:

   DtScenarioMergeDirector();

   virtual ~DtScenarioMergeDirector();

   DtScenarioMergeDirector(
      const DtScenarioMergeDirector& orig);

   DtScenarioMergeDirector& operator=(
      const DtScenarioMergeDirector& orig);


public:
   virtual void addInputScenario(const DtFilename& scenarioFile);

   virtual void setOutputScenarioName(const DtFilename& scenarioFile);

   virtual bool executeMerge();

   virtual DtlObjPtr arrangeDesignators(const char *pMergedOobStrBuff);

   virtual DtString bufferedMtlStringReplace(const char *pToFindString,
      const char *pReplaceWithString,
      const char *pInFileName);

   virtual void clear();

   virtual bool checkScenarioMergeData();

   virtual void createNewProject();

   virtual int computeMtlBufferOffset(const char *pBuffer,
      unsigned numFieldsToSkip,
      bool bFirstFieldIsList = true);

   virtual int lengthUnusedData(const char* pBuffer);

   virtual bool deconflict();
   
   bool deconflictMtlStream(const DtString& sScenarioName,
      const DtlObjPtr& oob);

   virtual bool doAllSubstitutions();
   virtual bool doSubstitutions(FileType ftype,
      DtString& sResultsBuffer);

   virtual bool doSimpleFileTransfer(const DtFilename& sFrom,
      const DtFilename& sTo);

   virtual bool getFilenameForType(
      FileType ftype,
      const DtScenario& scn,
      DtFilename& fnameOut) const;

   virtual bool loadProject();
   virtual bool loadProject(const DtFilename& fname);

   virtual bool loadScenarioMergeData();
   virtual bool loadScenarioMergeData(const DtFilename& fname);

   virtual void mergeAdditionalOpdLists(DtScenario& outputScenario);

   virtual void mergeSimulationModelSetLists(DtScenario& outputScenario);

   virtual DtScenarioMergeProject* project();
   virtual const DtScenarioMergeProject* project() const;

   virtual void replaceObjectNames(DtString& sBuffer,
      const DtString& sForScnName,
      const char *pFormatString="%s");

   virtual void reportObjectNameSubstitutions() const;

   virtual bool saveAsProject(const DtFilename& fname);
   virtual bool saveProject();

   virtual DtScenarioMergeData& scenarioMergeData();
   virtual const DtScenarioMergeData& scenarioMergeData() const;

   virtual bool validate(const DtScenario& keyScenario,
      const DtScenario& otherScenario);

protected:
   
   virtual void readOOBFile(char* pReadBuffer, FILE* fpIn, bool isKeyScenario);

   virtual bool acceptOOBObject(const std::string& objStr, bool isKeyScenario)
      const;

   virtual bool transferScenarioFiles(DtScenario& outputScenario,
      const DtFilename &outputName);


protected:


protected:
   
   DtScenarioMergeData myScenarioMergeData;
   DtScenarioMergeProject *pMyProject;

};