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