src/Model/Model_Objects.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        Model_Objects.h
   4 // Created:     15 May 2015
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef Model_Objects_H_
   8 #define Model_Objects_H_
   9
  10 #include <Model.h>
  11 #include <ModelAPI_Document.h>
  12 #include <ModelAPI_Feature.h>
  13 #include <ModelAPI_Result.h>
  14 #include <ModelAPI_ResultParameter.h>
  15
  16 #include <TDocStd_Document.hxx>
  17 #include <NCollection_DataMap.hxx>
  18 #include <TDF_Label.hxx>
  19 #include <TDF_LabelList.hxx>
  20 #include <map>
  21 #include <set>
  22 #include <vector>
  23
  24 // for TDF_Label map usage
  25 static Standard_Integer HashCode(const TDF_Label& theLab, const Standard_Integer theUpper);
  26 static Standard_Boolean IsEqual(const TDF_Label& theLab1, const TDF_Label& theLab2);
  27
  28 /**\class Model_Objects
  29  * \ingroup DataModel
  30  * \brief Manager of objects of the document. Normally one this class corresponds to
  31  * one document and just helper to manage objects (ModelAPI_Objects) inside of the document
  32  * on the level of data storage.
  33  */
  34 class Model_Objects
  35 {
  36  public:
  37   //! Registers the fieature in the data structure
  38   //! \param theFeature feature that must be added to the data structure
  39   //! \param theAfterThis the feature will be added after this feature;
  40   //!        if it is null, the added feature will be the first
  41   void addFeature(FeaturePtr theFeature, const FeaturePtr theAfterThis);
  42
  43   //! Return a list of features, which refers to the feature
  44   //! \param theFeature a feature
  45   //! \param theRefs a list of reference features
  46   //! \param isSendError a flag whether the error message should be send
  47   void refsToFeature(FeaturePtr theFeature,
  48                      std::set<FeaturePtr>& theRefs,
  49                      const bool isSendError = true);
  50
  51   //! Removes the feature from the document (with result)
  52   //! \param theFeature a removed feature
  53   void removeFeature(FeaturePtr theFeature);
  54
  55   //! Moves the feature to make it after the given one in the history.
  56   void moveFeature(FeaturePtr theMoved, FeaturePtr theAfterThis);
  57
  58   //! Returns the existing feature by the label
  59   //! \param theLabel base label of the feature
  60   FeaturePtr feature(TDF_Label theLabel) const;
  61
  62   //! Returns the existing object: result or feature
  63   //! \param theLabel base label of the object
  64   ObjectPtr object(TDF_Label theLabel);
  65
  66   //! Returns the first found object in the group by the object name
  67   //! \param theGroupID group that contains an object
  68   //! \param theName name of the object to search
  69   //! \returns null if such object is not found
  70   std::shared_ptr<ModelAPI_Object> objectByName(
  71     const std::string& theGroupID, const std::string& theName);
  72
  73   //! Returns the result by the result name
  74   ResultPtr findByName(const std::string theName);
  75
  76
  77   //! Returns the object index in the group. Object must be visible. Otherwise returns -1.
  78   //! \param theObject object of this document
  79   //! \returns index started from zero, or -1 if object is invisible or belongs to another document
  80   const int index(std::shared_ptr<ModelAPI_Object> theObject);
  81
  82   //! Returns the feature in the group by the index (started from zero)
  83   //! \param theGroupID group that contains a feature
  84   //! \param theIndex zero-based index of feature in the group
  85   ObjectPtr object(const std::string& theGroupID, const int theIndex);
  86
  87   //! Returns the number of features in the group
  88   int size(const std::string& theGroupID);
  89
  90   ///! Returns all (and disabled) results of the given type. Not fast method (iterates all features).
  91   void allResults(const std::string& theGroupID, std::list<ResultPtr>& theResults);
  92
  93   //! Returns the number of all features: in the history or not
  94   int numInternalFeatures();
  95   //! Returns the feature by zero-based index: features in the history or not
  96   std::shared_ptr<ModelAPI_Feature> internalFeature(const int theIndex);
  97
  98   /// Creates a construction results
  99   std::shared_ptr<ModelAPI_ResultConstruction> createConstruction(
 100       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
 101   /// Creates a body results
 102   std::shared_ptr<ModelAPI_ResultBody> createBody(
 103       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
 104   /// Creates a part results
 105   std::shared_ptr<ModelAPI_ResultPart> createPart(
 106       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
 107   /// Copies a part results, keeping the reference to origin
 108   std::shared_ptr<ModelAPI_ResultPart> copyPart(
 109       const std::shared_ptr<ModelAPI_ResultPart>& theOrigin,
 110       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
 111   /// Creates a group results
 112   std::shared_ptr<ModelAPI_ResultGroup> createGroup(
 113       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
 114
 115   std::shared_ptr<ModelAPI_ResultParameter> createParameter(
 116       const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theIndex = 0);
 117
 118   //! Returns a feature by result (owner of result)
 119   std::shared_ptr<ModelAPI_Feature>
 120     feature(const std::shared_ptr<ModelAPI_Result>& theResult);
 121
 122   //! Sets the owner of this manager
 123   void setOwner(DocumentPtr theDoc);
 124
 125   //! Returns the owner of this manager
 126   DocumentPtr owner() {return myDoc;}
 127
 128   //! Deletes all managed features wit hemmitting of corresponded signal
 129   ~Model_Objects();
 130
 131  protected:
 132
 133   //! Returns (creates if needed) the features label
 134   TDF_Label featuresLabel() const;
 135
 136   //! Initializes feature with a unique name in this group (unique name is generated as
 137   //! feature type + "_" + index
 138   void setUniqueName(FeaturePtr theFeature);
 139
 140   //! Synchronizes myFeatures list with the updated document
 141   //! \param theUpdated list of labels that are marked as modified, so featrues must be also
 142   //! \param theUpdateReferences causes the update of back-references
 143   //! \param theFlush makes flush all events in the end of all modifications of this method
 144   void synchronizeFeatures(const TDF_LabelList& theUpdated, const bool theUpdateReferences,
 145     const bool theFlush);
 146   //! Synchronizes the BackReferences list in Data of Features and Results
 147   void synchronizeBackRefs();
 148
 149   //! Creates manager on the OCAF document main label
 150   Model_Objects(TDF_Label theMainLab);
 151
 152   //! Initializes the data fields of the feature
 153   void initData(ObjectPtr theObj, TDF_Label theLab, const int theTag);
 154
 155   //! Allows to store the result in the data tree of the document (attaches 'data' of result to tree)
 156   void storeResult(std::shared_ptr<ModelAPI_Data> theFeatureData,
 157                    std::shared_ptr<ModelAPI_Result> theResult,
 158                    const int theResultIndex = 0);
 159
 160   //! returns the label of result by index; creates this label if it was not created before
 161   TDF_Label resultLabel(const std::shared_ptr<ModelAPI_Data>& theFeatureData, const int theResultIndex);
 162
 163   //! Updates the results list of the feature basing on the current data tree
 164   void updateResults(FeaturePtr theFeature);
 165
 166   /// Internally makes document know that feature was removed or added in history after creation
 167   void updateHistory(const std::shared_ptr<ModelAPI_Object> theObject);
 168
 169   /// Internally makes document know that feature was removed or added in history after creation
 170   void updateHistory(const std::string theGroup);
 171
 172   /// Clears the history arrays related to this object
 173   void clearHistory(ObjectPtr theObj);
 174
 175   /// Creates the history: up to date with the current state
 176   void createHistory(const std::string& theGroupID);
 177
 178   /// Returns to the next (from the history point of view) feature, any: invisible or disabled
 179   /// \param theReverse if it is true, iterates in reverced order (next becomes previous)
 180   FeaturePtr nextFeature(FeaturePtr theCurrent, const bool theReverse = false);
 181   /// Returns to the first (from the history point of view) feature, any: invisible or disabled
 182   FeaturePtr firstFeature();
 183   /// Returns to the last (from the history point of view) feature, any: invisible or disabled
 184   FeaturePtr lastFeature();
 185
 186   /// Returns the result group identifier of the given feature (for this at least one result must
 187   /// be created before)
 188   std::string featureResultGroup(FeaturePtr theFeature);
 189
 190   ///! Returns all features of the document including the hidden features which are not in
 191   ///! history. Not very fast method, for calling once, not in big cycles.
 192   std::list<std::shared_ptr<ModelAPI_Feature> > allFeatures();
 193
 194
 195  private:
 196   TDF_Label myMain; ///< main label of the data storage
 197
 198   DocumentPtr myDoc; ///< doc,ument, owner of this objects manager: needed for events creation
 199
 200   /// All managed features (not only in history of OB)
 201   /// For optimization mapped by labels
 202   NCollection_DataMap<TDF_Label, FeaturePtr> myFeatures;
 203
 204   /// Map from group id to the array that contains all objects located in history.
 205   /// Each array is updated by demand from scratch, by browing all the features in the history.
 206   std::map<std::string, std::vector<ObjectPtr> > myHistory;
 207
 208   friend class Model_Document;
 209   friend class Model_Session;
 210   friend class Model_Update;
 211   friend class Model_AttributeReference;
 212   friend class Model_AttributeRefAttr;
 213   friend class Model_AttributeRefList;
 214 };
 215
 216 #endif