Model_Session.h

// Copyright (C) 2014-2025  CEA, EDF
//
// This library is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// This library is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
//
// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
//
 
#ifndef Model_Session_H_
#define Model_Session_H_
 
#include "Model.h"
#include <ModelAPI_Session.h>
#include <ModelAPI_Feature.h>
 
#include <Events_Listener.h>
#include <map>
 
#ifdef TINSPECTOR
#include <TDocStd_Application.hxx>
#endif
 
class Model_Document;
 
class Model_Session : public ModelAPI_Session, public Events_Listener
{
  bool myPluginsInfoLoaded;  
  std::map<std::string, std::pair<std::string, std::string> > myPlugins;
  std::map<std::string, ModelAPI_Plugin*> myPluginObjs;  
  std::string myCurrentPluginName;  
  std::shared_ptr<ModelAPI_Document> myCurrentDoc;  
  std::map<std::string, std::string> myUsePlugins;
 
  bool myCheckTransactions;
  std::list<bool> myOperationAttachedToNext;
 public:
 
  MODEL_EXPORT virtual bool load(const char* theFileName);
 
  MODEL_EXPORT virtual bool save(const char* theFileName, std::list<std::string>& theResults, bool doBackup=false);
 
  MODEL_EXPORT virtual void closeAll();
 
  MODEL_EXPORT virtual void startOperation(
    const std::string& theId = "", const bool theAttachedToNested = false);
  MODEL_EXPORT virtual void finishOperation();
  MODEL_EXPORT virtual void abortOperation();
  MODEL_EXPORT virtual bool isOperation();
  MODEL_EXPORT virtual bool isModified();
 
  MODEL_EXPORT virtual bool canUndo();
  MODEL_EXPORT virtual void undo();
  MODEL_EXPORT virtual bool canRedo();
  MODEL_EXPORT virtual void redo();
  MODEL_EXPORT virtual std::list<std::string> undoList();
  MODEL_EXPORT virtual std::list<std::string> redoList();
  MODEL_EXPORT virtual void clearUndoRedo();
 
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> moduleDocument();
 
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> document(int theDocID);
 
  MODEL_EXPORT virtual bool hasModuleDocument();
 
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> activeDocument();
 
  MODEL_EXPORT virtual void setActiveDocument(
    std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true);
 
  MODEL_EXPORT virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments();
 
  MODEL_EXPORT virtual bool isLoadByDemand(const std::wstring theDocID, const int theDocIndex);
 
  MODEL_EXPORT virtual void registerPlugin(ModelAPI_Plugin* thePlugin);
 
  MODEL_EXPORT virtual bool checkLicense(const std::string& thePluginName);
 
  MODEL_EXPORT virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 
  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> copy(
      std::shared_ptr<ModelAPI_Document> theSource, const int theDestID);
 
  MODEL_EXPORT virtual ModelAPI_ValidatorsFactory* validators();
 
  MODEL_EXPORT virtual ModelAPI_FiltersFactory* filters();
 
  void setCheckTransactions(const bool theCheck)
  {
    myCheckTransactions = theCheck;
  }
 
  Model_Session();
 
  MODEL_EXPORT virtual int transactionID();
 
 
  MODEL_EXPORT virtual bool isAutoUpdateBlocked();
 
  MODEL_EXPORT virtual void blockAutoUpdate(const bool theBlock);
 
#ifdef TINSPECTOR
  MODEL_EXPORT virtual Handle(TDocStd_Application) application();
#endif
 
 protected:
  void LoadPluginsInfo();
 
  FeaturePtr createFeature(std::string theFeatureID, Model_Document* theDocOwner);
 
  ModelAPI_Plugin* getPlugin(const std::string& thePluginName);
 
  friend class Model_Document;
  friend class Model_Objects;
};
 
#endif