ModelAPI_Document.h

// Copyright (C) 2014-2026  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_Document_H_
#define ModelAPI_Document_H_
 
#include "ModelAPI.h"
#include "ModelAPI_Entity.h"
 
#include <string>
#include <memory>
#include <vector>
#include <list>
#include <set>
#include <map>
 
class ModelAPI_Feature;
class ModelAPI_Folder;
class ModelAPI_Object;
class ModelAPI_Result;
class ModelAPI_ResultConstruction;
class ModelAPI_ResultBody;
class ModelAPI_ResultPart;
class ModelAPI_ResultGroup;
class ModelAPI_ResultField;
class ModelAPI_ResultParameter;
class ModelAPI_Data;
class GeomAPI_Shape;
 
class ModelAPI_Document: public ModelAPI_Entity
{
public:
  virtual const std::string& kind() const = 0;
 
  virtual void close(const bool theForever = false) = 0;
 
  virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID,
    const bool theMakeCurrent = true) = 0;
 
  virtual void refsToFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
                             std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
                             const bool isSendError = true) = 0;
 
  virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
 
  virtual void moveFeature(std::shared_ptr<ModelAPI_Feature> theMoved,
                           std::shared_ptr<ModelAPI_Feature> theAfterThis,
                           const bool theSplit = false) = 0;
 
  virtual const int id() const = 0;
 
  virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
                                                  const int theIndex,
                                                  const bool theAllowFolder = false) = 0;
 
  virtual std::shared_ptr<ModelAPI_Object> objectByName(const std::string& theGroupID,
                                                    const std::wstring& theName) = 0;
 
  virtual int index(std::shared_ptr<ModelAPI_Object> theObject,
                    const bool theAllowFolder = false) = 0;
 
  virtual int size(const std::string& theGroupID, const bool theAllowFolder = false) = 0;
 
  virtual std::shared_ptr<ModelAPI_Object> parent(
    const std::shared_ptr<ModelAPI_Object> theChild) = 0;
 
  virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible) = 0;
 
  virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
    const bool theVisible) = 0;
  virtual void setCurrentFeatureUp() = 0;
 
  virtual int numInternalFeatures() = 0;
  virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex) = 0;
  virtual void synchronizeTransactions() = 0;
 
  MODELAPI_EXPORT virtual ~ModelAPI_Document();
 
  virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
      const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
      const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
      const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  virtual std::shared_ptr<ModelAPI_ResultPart> copyPart(
      const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
      const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
      const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  virtual std::shared_ptr<ModelAPI_ResultField> createField(
      const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
  virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
      const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
 
  virtual std::shared_ptr<ModelAPI_Feature> feature(
      const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
 
  virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures() = 0;
 
  virtual std::list<std::shared_ptr<ModelAPI_Object> > allObjects() = 0;
 
  virtual std::shared_ptr<ModelAPI_Folder> addFolder(
      std::shared_ptr<ModelAPI_Feature> theAddBefore = std::shared_ptr<ModelAPI_Feature>()) = 0;
  virtual void removeFolder(std::shared_ptr<ModelAPI_Folder> theFolder) = 0;
  virtual std::shared_ptr<ModelAPI_Folder> findFolderAbove(
      const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures) = 0;
  virtual std::shared_ptr<ModelAPI_Folder> findFolderBelow(
      const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures) = 0;
  virtual std::shared_ptr<ModelAPI_Folder> findContainingFolder(
      const std::shared_ptr<ModelAPI_Feature>& theFeature,
      int& theIndexInFolder) = 0;
  virtual bool moveToFolder(const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
                            const std::shared_ptr<ModelAPI_Folder>& theFolder) = 0;
  virtual bool removeFromFolder(
      const std::list<std::shared_ptr<ModelAPI_Feature> >& theFeatures,
      const bool theBefore = true) = 0;
 
  virtual void setActive(const bool theFlag) = 0;
  virtual bool isActive() const = 0;
 
  virtual bool isOpened() = 0;
 
  virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
    std::shared_ptr<ModelAPI_Result> theResult,
    const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
 
  virtual bool isLater(std::shared_ptr<ModelAPI_Feature> theLater,
                       std::shared_ptr<ModelAPI_Feature> theCurrent) const = 0;
 
  MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0;
 
  MODELAPI_EXPORT virtual void storeNodesState(const std::list<bool>& theStates) = 0;
 
  MODELAPI_EXPORT virtual void restoreNodesState(std::list<bool>& theStates) const = 0;
 
  MODELAPI_EXPORT virtual void eraseAllFeatures() = 0;
 
  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Feature> nextFeature(
    std::shared_ptr<ModelAPI_Feature> theCurrent, const bool theReverse = false) const = 0;
 
  MODELAPI_EXPORT virtual bool importPart(const char* theFileName,
                                      std::list<std::shared_ptr<ModelAPI_Feature> >& theImported,
                                      bool theCheckOnly = false) = 0;
 
  MODELAPI_EXPORT virtual bool save(const char* theFilename,
    const std::list<std::shared_ptr<ModelAPI_Feature> >& theExportFeatures) const = 0;
 
protected:
  MODELAPI_EXPORT ModelAPI_Document();
 
  MODELAPI_EXPORT virtual void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
 
  friend class ModelAPI_Object; // to add or remove from the history
  friend class ModelAPI_Result; // to add or remove from the history
};
 
typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;
 
#endif