Salome HOME
Merge branch 'master' into BR_PYTHON_PLUGIN
[modules/shaper.git] / src / ModelAPI / ModelAPI_Data.h
index c7ee92059613b76f6a390a019a171953ffe3de9f..191345f1a7313c9359c7f17b4907d852a2dbff43 100644 (file)
@@ -2,22 +2,28 @@
 // Created:     21 Mar 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef ModelAPI_Data_HeaderFile
-#define ModelAPI_Data_HeaderFile
+#ifndef ModelAPI_Data_H_
+#define ModelAPI_Data_H_
 
 #include "ModelAPI.h"
 #include <string>
 #include <list>
+#include <set>
 #include <boost/shared_ptr.hpp>
 
 class ModelAPI_AttributeDocRef;
+class ModelAPI_AttributeInteger;
 class ModelAPI_AttributeDouble;
 class ModelAPI_AttributeReference;
 class ModelAPI_AttributeRefAttr;
 class ModelAPI_AttributeRefList;
 class ModelAPI_AttributeBoolean;
+class ModelAPI_AttributeString;
 class ModelAPI_Document;
 class ModelAPI_Attribute;
+class ModelAPI_Feature;
+class ModelAPI_AttributeSelection;
+class ModelAPI_AttributeSelectionList;
 class GeomAPI_Shape;
 
 /**\class ModelAPI_Data
@@ -28,7 +34,7 @@ class GeomAPI_Shape;
 
 class MODELAPI_EXPORT ModelAPI_Data
 {
-public:
+ public:
 
   /// Returns the name of the feature visible by the user in the object browser
   virtual std::string name() = 0;
@@ -37,25 +43,37 @@ public:
   virtual void setName(const std::string& theName) = 0;
 
   /// Returns the attribute that references to another document
-  virtual boost::shared_ptr<ModelAPI_AttributeDocRef> docRef(const std::string& theID) = 0;
+  virtual boost::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID) = 0;
   /// Returns the attribute that contains real value with double precision
   virtual boost::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID) = 0;
+  /// Returns the attribute that contains integer value
+  virtual boost::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID) = 0;
   /// Returns the attribute that contains reference to a feature
   virtual boost::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID) = 0;
+  /// Returns the attribute that contains selection to a shape
+  virtual boost::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID) = 0;
+  /// Returns the attribute that contains selection to a shape
+  virtual boost::shared_ptr<ModelAPI_AttributeSelectionList> 
+    selectionList(const std::string& theID) = 0;
   /// Returns the attribute that contains reference to an attribute of a feature
   virtual boost::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID) = 0;
   /// Returns the attribute that contains list of references to features
   virtual boost::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID) = 0;
   /// Returns the attribute that contains boolean value
   virtual boost::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID) = 0;
+  /// Returns the attribute that contains boolean value
+  virtual boost::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID) = 0;
 
   /// Returns the generic attribute by identifier
   /// \param theID identifier of the attribute
   virtual boost::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID) = 0;
-  /// Returns all attributes ofthe feature of the given type
+  /// Returns all attributes of the feature of the given type
   /// or all attributes if "theType" is empty
   virtual std::list<boost::shared_ptr<ModelAPI_Attribute> >
-    attributes(const std::string& theType) = 0;
+  attributes(const std::string& theType) = 0;
+  /// Returns all attributes ids of the feature of the given type
+  /// or all attributes if "theType" is empty
+  virtual std::list<std::string> attributesIDs(const std::string& theType) = 0;
   /// Identifier by the id (not fast, iteration by map)
   /// \param theAttr attribute already created in this data
   virtual const std::string& id(const boost::shared_ptr<ModelAPI_Attribute>& theAttr) = 0;
@@ -74,16 +92,34 @@ public:
   /// makes attribute initialized
   virtual void sendAttributeUpdated(ModelAPI_Attribute* theAttr) = 0;
 
+  /// Erases all the data from the data model
+  virtual void erase() = 0;
+
   /// To virtually destroy the fields of successors
-  virtual ~ModelAPI_Data() {}
+  virtual ~ModelAPI_Data()
+  {
+  }
+
+  /// Makes feature must be updated later (on rebuild). Normally the Updater must call it
+  /// in case of not-automatic update to true
+  virtual void mustBeUpdated(const bool theFlag) = 0;
 
-protected:
+  /// Returns true if feature must be updated (re-executed) on rebuild
+  virtual bool mustBeUpdated() = 0;
+
+  /// Returns the identifier of feature-owner, unique in this document
+  virtual int featureId() const = 0;
+
+ // returns all objects referenced to this
+  virtual const std::set<boost::shared_ptr<ModelAPI_Attribute> >& refsToMe() = 0;
+
+ protected:
   /// Objects are created for features automatically
   ModelAPI_Data()
-  {}
+  {
+  }
 };
 
 typedef boost::shared_ptr<ModelAPI_Data> DataPtr;
 
-
 #endif