- //! Removes document data
- MODELAPI_EXPORT virtual void Close() = 0;
-
- //! Starts a new operation (opens a tansaction)
- MODELAPI_EXPORT virtual void StartOperation() = 0;
- //! Finishes the previously started operation (closes the transaction)
- MODELAPI_EXPORT virtual void FinishOperation() = 0;
- //! Aborts the operation
- MODELAPI_EXPORT virtual void AbortOperation() = 0;
- //! Returns true if operation has been started, but not yet finished or aborted
- MODELAPI_EXPORT virtual bool IsOperation() = 0;
- //! Returns true if document was modified (since creation/opening)
- MODELAPI_EXPORT virtual bool IsModified() = 0;
-
- //! Returns True if there are available Undos
- MODELAPI_EXPORT virtual bool CanUndo() = 0;
- //! Undoes last operation
- MODELAPI_EXPORT virtual void Undo() = 0;
- //! Returns True if there are available Redos
- MODELAPI_EXPORT virtual bool CanRedo() = 0;
- //! Redoes last operation
- MODELAPI_EXPORT virtual void Redo() = 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
+ //! \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 std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
+
+ ///! Returns the id of the document
+ virtual const std::string& 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
+ 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
+ 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.
+ //! \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;
+
+ /// To virtually destroy the fields of successors
+ MODELAPI_EXPORT virtual ~ModelAPI_Document();
+
+ /// Creates a construction cresults
+ virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
+ const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
+ /// Creates a body results
+ virtual std::shared_ptr<ModelAPI_ResultBody> createBody(
+ const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
+ /// Creates a part results
+ virtual std::shared_ptr<ModelAPI_ResultPart> createPart(
+ const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0) = 0;
+ /// Creates a group results
+ virtual std::shared_ptr<ModelAPI_ResultGroup> createGroup(
+ 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;
+
+ //! Returns a feature by result (owner of result)
+ virtual std::shared_ptr<ModelAPI_Feature> feature(
+ const std::shared_ptr<ModelAPI_Result>& theResult) = 0;