ModelAPI_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 ModelAPI_Session_H_
#define ModelAPI_Session_H_
 
#include "ModelAPI.h"
#include <string>
#include <list>
#include <memory>
 
class ModelAPI_Feature;
class ModelAPI_Plugin;
class ModelAPI_Document;
class ModelAPI_ValidatorsFactory;
class ModelAPI_FiltersFactory;
 
class MODELAPI_EXPORT ModelAPI_Session
{
protected:
  bool myIsLoading; 
 
 public:
  static std::shared_ptr<ModelAPI_Session> get();
 
  virtual bool load(const char* theFileName) = 0;
 
  virtual bool isLoading() { return myIsLoading; };
 
  virtual bool save(const char* theFileName, std::list<std::string>& theResults, bool isBackup=false) = 0;
 
  virtual void closeAll() = 0;
 
  virtual void startOperation(
    const std::string& theId = "", const bool theAttachedToNested = false) = 0;
  virtual void finishOperation() = 0;
  virtual void abortOperation() = 0;
  virtual bool isOperation() = 0;
  virtual bool isModified() = 0;
 
  virtual bool canUndo() = 0;
  virtual void undo() = 0;
  virtual bool canRedo() = 0;
  virtual void redo() = 0;
  virtual std::list<std::string> undoList() = 0;
  virtual std::list<std::string> redoList() = 0;
  virtual void clearUndoRedo() = 0;
 
  virtual void registerPlugin(ModelAPI_Plugin* thePlugin) = 0;
 
  virtual bool checkLicense(const std::string& thePluginName) = 0;
 
  virtual std::shared_ptr<ModelAPI_Document> moduleDocument() = 0;
 
  virtual std::shared_ptr<ModelAPI_Document> document(int theDocID) = 0;
 
  virtual bool hasModuleDocument() = 0;
 
  virtual std::shared_ptr<ModelAPI_Document> activeDocument() = 0;
 
  virtual void setActiveDocument(
    std::shared_ptr<ModelAPI_Document> theDoc, bool theSendSignal = true) = 0;
 
  virtual std::list<std::shared_ptr<ModelAPI_Document> > allOpenedDocuments() = 0;
 
  virtual bool isLoadByDemand(const std::wstring theDocID, const int theDocIndex) = 0;
 
  virtual std::shared_ptr<ModelAPI_Document> copy(
    std::shared_ptr<ModelAPI_Document> theSource, const int theDestID) =0;
 
  virtual ModelAPI_ValidatorsFactory* validators() = 0;
 
  virtual ModelAPI_FiltersFactory* filters() = 0;
 
  virtual ~ModelAPI_Session()
  {
  }
 
  virtual int transactionID() = 0;
 
  virtual bool isAutoUpdateBlocked() = 0;
 
  virtual void blockAutoUpdate(const bool theBlock) = 0;
 
 protected:
  static void setSession(std::shared_ptr<ModelAPI_Session> theManager);
};
 
typedef std::shared_ptr<ModelAPI_Session> SessionPtr;
 
#endif