simulationModelSetLoader.h

Go to the documentation of this file.

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


#ifndef DtSimulationModelSetLoader_H_
#define DtSimulationModelSetLoader_H_

#include "vrfutil/simulationModelSet.h"
#include <vrfutil/rwForces.h>
#include <vlutil/vlFilename.h>
#include <QtCore/QHash>
#include <QtGui/QPixmap>
#include <QtCore/QObject>

#include <vrfGuiCore/entityMapperKey.h>

class DtVrfParameterDb;
class DtObjectType;
class DtModelSet;
class DtMtlParameterDbEntry;
class DtVrfObjectParameters;
class DtMenu;
class DtVrfParameterDbEntry;
class DtModelSetEntry;
class DtComponentSystemDatabase;
class MyMtlParameterDbEntry;
class QComboBox;
class DtEntityMapperKey;
class DtSimulationModelSetLoader;

typedef DtVrfParameterDb* (*DtParameterDatabaseCreatorFcn) ();

#include "entityEditorImpl/entityEditorImplDefines.h"

namespace makVrv
{
   class DtDe;
}

typedef DtSimulationModelSetLoader* (*DtSimulationModelSetLoaderCreatorFcn)(makVrv::DtDe*);

class DT_DLL_entityeditorimpl DtSimulationModelSetLoader : public QObject
{
   Q_OBJECT

public:

   DtSimulationModelSetLoader(makVrv::DtDe* = 0);

   virtual ~DtSimulationModelSetLoader();

   virtual bool load(const DtSimulationModelSet&);
   virtual bool save(const DtFilename&);

private:
   DtSimulationModelSetLoader(const DtSimulationModelSetLoader&);
   DtSimulationModelSetLoader& operator=(const DtSimulationModelSetLoader&);

public:

   DtFilename simulationModelSetFilename() const;

   virtual bool openOpdFile(const DtFilename& filename);

   virtual bool openSystemFiles(const DtVrfParameterDb* opd);

   virtual bool openEntFile(const DtFilename& filename);
   virtual bool loadModelSet(const DtFilename& f);

   virtual bool loadAllOpdParameters(bool canCancel = true, const QString& label = "");

   virtual bool loadForceHostilityFile(const DtFilename& f);

   virtual DtModelSetEntry* modifiedModelValue(DtModelSetEntry*, bool createIfMissing = true);

   virtual DtModelSetEntry* modelEntry(const DtObjectType&, bool createIfMissing = false);
   virtual DtModelSetEntry* modelEntry(DtModelSet*, const DtObjectType&, bool createIfMissing = false);

   virtual void revertParameterDatabase();

   virtual DtString opdVariableValue(const DtString& variableName) const;

   virtual DtString substituteVariableInPath(const DtFilename& filePath, const DtString& variableName) const;

   virtual MyMtlParameterDbEntry* parameterEntryFor(const DtObjectType&,
      const DtObjectType& original = DtObjectType(-1, -1, -1, -1, -1, -1, -1, -1));

   virtual bool containsObjectType(const DtObjectType&);

   virtual bool hasModelNamed(const DtString&);

   virtual bool isModified() const;

   void setDefaultCategories(const QStringList&);
   void addDefaultCategory(const QString&);
   const QStringList& defaultCategories() const;
   virtual void changeDefaultCategory(const QString& old, const QString& newCat);
   virtual void addDefaultCategories(QComboBox*);
   virtual void revertCategories();
   virtual void parameterChanged(const DtVrfObjectParameters*, const DtObjectType&, const DtObjectType&);

   virtual void replaceSystem(const DtFilename&);

   virtual void removeSystem(const DtFilename&);

   DtFilename getSystemDirectory() const;
   DtFilename getFormationDirectory() const;

   virtual QPixmap getIcon(const makVrf::DtEntityMapperKey& key, int pointSize = 48,
      bool sizeToFont = false);

   virtual void clearIcons(const makVrf::DtEntityMapperKey& key);

   static DtSimulationModelSetLoader* create(makVrv::DtDe*);

public:
   static void setParameterDatabaseCreatorFcn(DtParameterDatabaseCreatorFcn);

   const DtModelSet* modelSet() const;
   DtModelSet* modelSet();
   const DtMenu* entityMenu() const;

   virtual void setEntityMenu(DtMenu* menu);
   virtual void revertEntityMenu();

   const DtVrfParameterDb* parameterDatabase() const;

   DtVrfParameterDb* parameterDatabase();
   const DtSimulationModelSet& simulationModelSet() const;
   const DtFilename& parameterFilename() const;
   const DtComponentSystemDatabase* systemDatabase() const;
   DtFilename modelSetDirectory() const;

   virtual void forceRemoved(DtForceType forceType);

   const DtRwForces& allForces() const;

   virtual bool hasModifiedCreateMenu() const;
   virtual bool hasModifiedCategories() const;
   virtual bool saveParameterDatabase(const DtFilename&);

protected:
   virtual DtVrfParameterDb* createDatabase(const DtFilename& filename);
   virtual DtVrfParameterDb* createParameterDatabase();

   virtual void loadSystemFilesFromDirectory(const QString& directoryName, 
      const DtVariableBindingsList& variableBindings);

   virtual void cleanup();

   virtual bool saveModelSet(const DtFilename&);

   virtual bool saveForceHostility(const DtFilename& filename);

   virtual bool warned(const DtFilename&);
   virtual void removeEntityFromSubObjects(const DtObjectType&);
   virtual bool filenameInUse(const DtFilename&, DtMtlParameterDbEntry*) const;

   virtual DtModelSet* createFavoritesFromModelSet(DtModelSet* s);

   virtual void mergeFavoritesIntoModelSet(DtModelSet* favorites, DtModelSet* set);

protected:
   QStringList myWarned;
   QList<DtVrfParameterDbEntry*> myMissing;
   DtSimulationModelSet mySimulationModelSet;
   DtMenu*           myEntMenu;
   DtMenu*           myModifiedMenu;
   DtVrfParameterDb* myParameterDatabase;
   DtComponentSystemDatabase* mySystemDatabase;
   DtFilename        myParameterFilename;
   DtModelSet*       myModelSet;
   DtModelSet*       myTempModelSet;
   DtRwForces        myAllForces;
   QStringList       myDefaultCategories;
   static DtParameterDatabaseCreatorFcn theParameterDatabaseCreatorFcn;
   makVrv::DtDe*     myDe;
};

inline DtFilename DtSimulationModelSetLoader::simulationModelSetFilename() const
{
   return mySimulationModelSet.filename();
}

inline const DtSimulationModelSet& DtSimulationModelSetLoader::simulationModelSet() const
{
   return mySimulationModelSet;
}

inline const DtVrfParameterDb* DtSimulationModelSetLoader::parameterDatabase() const
{
   return myParameterDatabase;
}

inline DtVrfParameterDb* DtSimulationModelSetLoader::parameterDatabase()
{
   return myParameterDatabase;
}

inline const DtModelSet* DtSimulationModelSetLoader::modelSet() const
{
   return myModelSet;
}

inline DtModelSet* DtSimulationModelSetLoader::modelSet()
{
   return myModelSet;
}

inline const DtFilename& DtSimulationModelSetLoader::parameterFilename() const
{
   return myParameterFilename;
}

inline const DtRwForces& DtSimulationModelSetLoader::allForces() const
{
   return myAllForces;
}

inline const QStringList& DtSimulationModelSetLoader::defaultCategories() const
{
   return myDefaultCategories;
}

inline void DtSimulationModelSetLoader::setDefaultCategories(const QStringList& l)
{
   myDefaultCategories = l;
}

inline void DtSimulationModelSetLoader::addDefaultCategory(const QString& l)
{
   myDefaultCategories.push_back(l);
}

extern DT_DLL_entityeditorimpl makVrf::DtEntityMapperKey mapperKeyConversion(const DtEntityMapperKey&, int force);
extern DT_DLL_entityeditorimpl makVrf::DtEntityMapperKey mapperKeyConversion(const DtObjectType&, int force);

#endif