+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
// File: ModelAPI_Document.cxx
// Created: 28 Feb 2014
// Author: Mikhail PONIKAROV
#ifndef ModelAPI_Document_H_
#define ModelAPI_Document_H_
-#include <ModelAPI.h>
+#include "ModelAPI.h"
+#include "ModelAPI_Entity.h"
+
#include <string>
-#include <boost/shared_ptr.hpp>
+#include <memory>
#include <vector>
#include <list>
+#include <set>
class ModelAPI_Feature;
class ModelAPI_Object;
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 Model_Document
+/**\class ModelAPI_Document
* \ingroup DataModel
* \brief Document for internal data structure of any object storage.
* Document contains all data that must be stored/retrived in the file.
* Also it provides acces to this data: open/save, transactions management etc.
*/
-class ModelAPI_Document
+class ModelAPI_Document: public ModelAPI_Entity
{
public:
//! Returns the kind of the document: "PartSet", "Part", or something else.
virtual const std::string& kind() const = 0;
//! Removes document data
- virtual void close() = 0;
+ //! \param theForever if it is false, document is just hiden
+ //! (to keep possibility make it back on Undo/Redo)
+ virtual void close(const bool theForever = false) = 0;
//! Adds to the document the new feature of the given feature id
- //! \param creates feature and puts it in the document (if it is not action)
- virtual boost::shared_ptr<ModelAPI_Feature> addFeature(std::string theID) = 0;
+ //! \param theID creates feature and puts it in the document (if it is not action)
+ //! \param theMakeCurrent to make current this new feature in this document
+ virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID,
+ const bool theMakeCurrent = true) = 0;
+
+ //! Return a list of features, which refers to the feature
+ //! \param theFeature a feature
+ //! \param theRefs a list of features
+ //! \param isSendError a flag whether the error message should be send
+ virtual void refsToFeature(std::shared_ptr<ModelAPI_Feature> theFeature,
+ std::set<std::shared_ptr<ModelAPI_Feature> >& theRefs,
+ const bool isSendError = true) = 0;
//! Removes the feature from the document
- virtual void removeFeature(boost::shared_ptr<ModelAPI_Feature> theFeature,
- const bool theCheck = true) = 0;
+ //! \param theFeature a feature to be removed
+ virtual void removeFeature(std::shared_ptr<ModelAPI_Feature> theFeature) = 0;
- ///! Adds a new sub-document by the identifier, or returns existing one if it is already exist
- virtual boost::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
+ //! Moves the feature to make it after the given one in the history.
+ virtual void moveFeature(std::shared_ptr<ModelAPI_Feature> theMoved,
+ std::shared_ptr<ModelAPI_Feature> theAfterThis) = 0;
///! Returns the id of the document
- virtual const std::string& id() const = 0;
+ virtual const int id() const = 0;
//! Returns the object in the group by the index (started from zero)
//! \param theGroupID group that contains an object
//! \param theIndex zero-based index of feature in the group
- //! \param theHidden if it is true, it counts also the features that are not in tree
- virtual boost::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
- const int theIndex,
- const bool theHidden = false) = 0;
+ virtual std::shared_ptr<ModelAPI_Object> object(const std::string& theGroupID,
+ const int theIndex) = 0;
+
+ //! Returns the first found object in the group by the object name
+ //! \param theGroupID group that contains an object
+ //! \param theName name of the object to search
+ //! \returns null if such object is not found
+ virtual std::shared_ptr<ModelAPI_Object> objectByName(const std::string& theGroupID,
+ const std::string& theName) = 0;
+
+ //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
+ //! \param theObject object of this document
+ //! \returns index started from zero, or -1 if object is invisible or belongs to another document
+ virtual const int index(std::shared_ptr<ModelAPI_Object> theObject) = 0;
//! Returns the number of objects in the group of objects
- //! If theHidden is true, it counts also the features that are not in tree
- virtual int size(const std::string& theGroupID, const bool theHidden = false) = 0;
-
- /// To virtually destroy the fields of successors
- virtual ~ModelAPI_Document()
- {
- }
-
- /// Creates a construction cresults
- virtual boost::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
- const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
- /// Creates a body results
- virtual boost::shared_ptr<ModelAPI_ResultBody> createBody(
- const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
- /// Creates a part results
- virtual boost::shared_ptr<ModelAPI_ResultPart> createPart(
- const boost::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
+ virtual int size(const std::string& theGroupID) = 0;
+
+ //! Returns the feature that is currently edited in this document, normally
+ //! this is the latest created feature
+ //! \param theVisible use visible features only: flag is true for Object Browser functionality
+ //! \returns null if next created feature must be the first
+ virtual std::shared_ptr<ModelAPI_Feature> currentFeature(const bool theVisible) = 0;
+
+ //! Sets the current feature: all features below will be disabled, new features
+ //! will be appended after this one. This method does not flushes the events appeared:
+ //! it will be done by the finishOperation, or direct flushes
+ //! \param theCurrent the selected feature as current: blow it everythin become disabled
+ //! \param theVisible use visible features only: flag is true for Object Browser functionality
+ virtual void setCurrentFeature(std::shared_ptr<ModelAPI_Feature> theCurrent,
+ const bool theVisible) = 0;
+ //! Makes the current feature one feature upper
+ virtual void setCurrentFeatureUp() = 0;
+
+ //! Returns the number of all features: in the history or not
+ virtual int numInternalFeatures() = 0;
+ //! Returns the feature by zero-based index: features in the history or not
+ virtual std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex) = 0;
+ //! Performs synchronization of transactions with the module document:
+ //! If some document is not active (by undo of activation) but in memory,
+ //! on activation the transactions must be synchronised because all redos performed
+ //! wihtout this participation
+ virtual void synchronizeTransactions() = 0;
+
+ //! Returns feature by the id of the feature (produced by the Data "featureId" method)
+ virtual std::shared_ptr<ModelAPI_Feature> featureById(const int theId) = 0;
+
+ //! To virtually destroy the fields of successors
+ MODELAPI_EXPORT virtual ~ModelAPI_Document();
+
+ //! Creates a construction result
+ virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
+ const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
+ //! Creates a body result
+ virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
+ const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
+ //! Creates a part result
+ virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
+ const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
+ //! Copies a part result, keeping the reference to the origin
+ 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;
+ //! Creates a group result
+ virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
+ const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
+ //! Creates a field result
+ virtual std::shared_ptr<ModelAPI_ResultField> createField(
+ const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
+ //! Creates a parameter result
+ virtual std::shared_ptr<ModelAPI_ResultParameter> createParameter(
+ const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
//! Returns a feature by result (owner of result)
- virtual boost::shared_ptr<ModelAPI_Feature> feature(
- const boost::shared_ptr<ModelAPI_Result>& theResult) = 0;
+ virtual std::shared_ptr<ModelAPI_Feature> feature(
+ const std::shared_ptr<ModelAPI_Result>& theResult) = 0;
+
+ //! Returns all features of the document including the hidden features which are not in
+ //! history. Not very fast method, for calling once, not in big cycles.
+ virtual std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures() = 0;
+
+ //! Informs the document that it becomes active and some actions must be performed
+ virtual void setActive(const bool theFlag) = 0;
+ //! Returns true if this document is currently active
+ virtual bool isActive() const = 0;
+
+ /// Returns true if document is opened and valid
+ virtual bool isOpened() = 0;
+
+ /// Returns the feature that produced the given face of the given result.
+ virtual std::shared_ptr<ModelAPI_Feature> producedByFeature(
+ std::shared_ptr<ModelAPI_Result> theResult,
+ const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
+
+ /// Returns true if theLater is in history of features creation later than theCurrent
+ virtual bool isLater(std::shared_ptr<ModelAPI_Feature> theLater,
+ std::shared_ptr<ModelAPI_Feature> theCurrent) const = 0;
+
+ //! Internally makes document know that feature was removed or added in history after creation
+ MODELAPI_EXPORT virtual void updateHistory(const std::string theGroup) = 0;
protected:
- /// Only for SWIG wrapping it is here
- MODELAPI_EXPORT ModelAPI_Document()
- {
- }
+ //! Only for SWIG wrapping it is here
+ MODELAPI_EXPORT ModelAPI_Document();
+
+ //! Internally makes document know that feature was removed or added in history after creation
+ 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
};
//! Pointer on document object
-typedef boost::shared_ptr<ModelAPI_Document> DocumentPtr;
+typedef std::shared_ptr<ModelAPI_Document> DocumentPtr;
#endif
