+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
// File: ModelAPI_Document.cxx
// Created: 28 Feb 2014
// Author: Mikhail PONIKAROV
#include <memory>
#include <vector>
#include <list>
+#include <set>
class ModelAPI_Feature;
class ModelAPI_Object;
class ModelAPI_ResultBody;
class ModelAPI_ResultPart;
class ModelAPI_ResultGroup;
+class ModelAPI_ResultParameter;
class ModelAPI_Data;
-/**\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.
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)
+ //! \param theID creates feature and puts it in the document (if it is not action)
virtual std::shared_ptr<ModelAPI_Feature> addFeature(std::string theID) = 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(std::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 std::shared_ptr<ModelAPI_Document> subDocument(std::string theDocID) = 0;
const int theIndex,
const bool theHidden = false) = 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 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()
- {
- }
+ MODELAPI_EXPORT virtual ~ModelAPI_Document();
/// Creates a construction cresults
virtual std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
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;
protected:
/// Only for SWIG wrapping it is here
- MODELAPI_EXPORT ModelAPI_Document()
- {
- }
+ MODELAPI_EXPORT ModelAPI_Document();
+
+ /// Internally makes document know that feature was removed or added in history after creation
+ MODELAPI_EXPORT virtual void addToHistory(const std::shared_ptr<ModelAPI_Object> theObject) = 0;
+
+ friend class ModelAPI_Object; // to add or remove from the history
};
//! Pointer on document object
