Salome HOME
Merge remote-tracking branch 'remotes/origin/master'
[modules/shaper.git] / src / Model / Model_Data.h
index da40e7d4a8de9e5247bd08e92167765da748209c..a5f9af4ed2c6eaf203f571db5eb1fca36ce2e28c 100644 (file)
@@ -1,8 +1,22 @@
-// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
-
-// File:        Model_Data.hxx
-// Created:     21 Mar 2014
-// Author:      Mikhail PONIKAROV
+// Copyright (C) 2014-2017  CEA/DEN, EDF R&D
+//
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License, or (at your option) any later version.
+//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or
+// email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
+//
 
 #ifndef Model_Data_H_
 #define Model_Data_H_
@@ -16,7 +30,9 @@
 #include <ModelAPI_AttributeRefAttr.h>
 #include <ModelAPI_AttributeReference.h>
 #include <ModelAPI_AttributeRefList.h>
+#include <ModelAPI_AttributeRefAttrList.h>
 #include <ModelAPI_AttributeString.h>
+#include <ModelAPI_AttributeStringArray.h>
 #include <ModelAPI_AttributeIntArray.h>
 #include <ModelAPI_Data.h>
 #include <ModelAPI_Feature.h>
@@ -55,6 +71,8 @@ class Model_Data : public ModelAPI_Data
   std::set<AttributePtr> myRefsToMe;
   /// flag that may block the "attribute updated" sending
   bool mySendAttributeUpdated;
+  /// if some attribute was changed, but mySendAttributeUpdated was false, this stores this
+  std::list<ModelAPI_Attribute*> myWasChangedButBlocked;
 
   /// Returns label of this feature
   TDF_Label label()
@@ -68,8 +86,12 @@ class Model_Data : public ModelAPI_Data
   friend class Model_AttributeReference;
   friend class Model_AttributeRefAttr;
   friend class Model_AttributeRefList;
+  friend class Model_AttributeRefAttrList;
   friend class Model_AttributeSelection;
   friend class Model_AttributeSelectionList;
+  friend class Model_ValidatorsFactory;
+  friend class Model_SelectionNaming;
+  friend class Model_ResultConstruction;
 
  public:
   /// The simplest constructor. "setLabel" must be called just after to initialize correctly.
@@ -82,6 +104,9 @@ class Model_Data : public ModelAPI_Data
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID);
   /// Returns the attribute that contains real value with double precision
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID);
+  /// Returns the attribute that contains double values array
+  MODEL_EXPORT virtual
+    std::shared_ptr<ModelAPI_AttributeDoubleArray> realArray(const std::string& theID);
   /// Returns the attribute that contains integer value
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeInteger>
     integer(const std::string& theID);
@@ -92,7 +117,7 @@ class Model_Data : public ModelAPI_Data
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelection>
     selection(const std::string& theID);
   /// Returns the attribute that contains selection to a shape
-  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelectionList> 
+  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeSelectionList>
     selectionList(const std::string& theID);
   /// Returns the attribute that contains reference to an attribute of a feature
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttr>
@@ -100,6 +125,10 @@ class Model_Data : public ModelAPI_Data
   /// Returns the attribute that contains list of references to features
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefList>
     reflist(const std::string& theID);
+  /// Returns the attribute that contains list of references to features
+  /// or reference to an attribute of a feature
+  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeRefAttrList>
+    refattrlist(const std::string& theID);
   /// Returns the attribute that contains boolean value
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeBoolean>
     boolean(const std::string& theID);
@@ -109,6 +138,12 @@ class Model_Data : public ModelAPI_Data
   /// Returns the attribute that contains integer values array
   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeIntArray>
     intArray(const std::string& theID);
+  /// Returns the attribute that contains string values array
+  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeStringArray>
+    stringArray(const std::string& theID);
+  /// Returns the attribute that contains string values array
+  MODEL_EXPORT virtual std::shared_ptr<ModelAPI_AttributeTables>
+    tables(const std::string& theID);
 
   /// Returns the generic attribute by identifier
   /// \param theID identifier of the attribute
@@ -140,14 +175,20 @@ class Model_Data : public ModelAPI_Data
   /// \param theID identifier of the attribute that can be referenced by this ID later
   /// \param theAttrType type of the created attribute (received from the type method)
   /// \returns the just created attribute
-  MODEL_EXPORT virtual AttributePtr 
+  MODEL_EXPORT virtual AttributePtr
     addAttribute(const std::string& theID, const std::string theAttrType);
 
   /// Useful method for "set" methods of the attributes: sends an UPDATE event and
   /// makes attribute initialized
   MODEL_EXPORT virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr);
   /// Blocks sending "attribute updated" if theBlock is true
-  MODEL_EXPORT virtual void blockSendAttributeUpdated(const bool theBlock);
+  /// \param theBlock allows switching on/off the blocking state
+  /// \param theSendMessage if false, it does not send the update message
+  ///            even if something is changed
+  ///            (normally is it used in attributeChanged because this message will be sent anyway)
+  /// \returns the previous state of block
+  MODEL_EXPORT virtual bool blockSendAttributeUpdated(
+    const bool theBlock, const bool theSendMessage = true);
 
   /// Puts feature to the document data sub-structure
   MODEL_EXPORT void setLabel(TDF_Label theLab);
@@ -183,7 +224,8 @@ class Model_Data : public ModelAPI_Data
   MODEL_EXPORT virtual const std::set<AttributePtr>& refsToMe() {return myRefsToMe;}
 
   /// returns all references by attributes of this data
-  /// \param theRefs returned list of pairs: id of referenced attribute and list of referenced objects
+  /// \param theRefs returned list of pairs:
+  ///                id of referenced attribute and list of referenced objects
   MODEL_EXPORT virtual void referencesToObjects(
     std::list<std::pair<std::string, std::list<ObjectPtr> > >& theRefs);
 
@@ -234,7 +276,7 @@ private:
   /// \param theFeature feature referenced to this
   /// \param theAttrID identifier of the attribute that is references from theFeature to this
   /// \param theApplyConcealment applies consealment flag changes
-  void addBackReference(FeaturePtr theFeature, std::string theAttrID, 
+  void addBackReference(FeaturePtr theFeature, std::string theAttrID,
     const bool theApplyConcealment = true);
 
   /// Makes the concealment flag up to date for this object-owner.