X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Feature.h;h=452686cdb20906749a9c312f2a720c0a32121adc;hb=38afbd899a8645c83e17f2c24a17a2b7414911b4;hp=dd98c597a02c7f466f9caa61a01ec77d804e5c38;hpb=503b5444d4a5fa95a3046a754f69f5b79e677e33;p=modules%2Fshaper.git

diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h
index dd98c597a..452686cdb 100644
--- a/src/ModelAPI/ModelAPI_Feature.h
+++ b/src/ModelAPI/ModelAPI_Feature.h
@@ -1,81 +1,170 @@
+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
 // File:        ModelAPI_Feature.hxx
 // Created:     21 Mar 2014
 // Author:      Mikhail PONIKAROV
 
-#ifndef ModelAPI_Feature_HeaderFile
-#define ModelAPI_Feature_HeaderFile
+#ifndef ModelAPI_Feature_H_
+#define ModelAPI_Feature_H_
 
-#include "ModelAPI.h"
-#include "ModelAPI_PluginManager.h"
+#include <ModelAPI.h>
+#include <ModelAPI_Object.h>
+#include <ModelAPI_Data.h>
+#include <ModelAPI_Document.h>
 
-#include <string>
-#include <boost/shared_ptr.hpp>
+#include <memory>
 
-class ModelAPI_Data;
-class ModelAPI_Document;
+#include <list>
+#include <string>
 
 /**\class ModelAPI_Feature
  * \ingroup DataModel
- * \brief Functionality of the model object: to update result,
- * to initialize attributes, etc.
+ * \brief Feature function that represents the particular functionality
+ * of this operation. Produces results by the arguments.
  */
-class ModelAPI_Feature
+class ModelAPI_Feature : public ModelAPI_Object
 {
-  boost::shared_ptr<ModelAPI_Data> myData; ///< manager of the data model of a feature
-  boost::shared_ptr<ModelAPI_Document> myDoc; ///< document this feature belongs to
+  ///< list of current results of this feature
+  std::list<std::shared_ptr<ModelAPI_Result> > myResults;
+ public:
+  /// Returns the unique kind of a feature (like "Point")
+  virtual const std::string& getKind() = 0;
+
+  /// Returns the group identifier of all features
+  static std::string group()
+  {
+    static std::string MY_GROUP = "Features";
+    return MY_GROUP;
+  }
 
-public:
-  /// Returns the kind of a feature (like "Point")
-  MODELAPI_EXPORT virtual const std::string& getKind() = 0;
+  /// Returns document this feature belongs to
+  virtual std::shared_ptr<ModelAPI_Document> document() const
+  {
+    return ModelAPI_Object::document();
+  }
 
-  /// Returns to which group in the document must be added feature
-  MODELAPI_EXPORT virtual const std::string& getGroup() = 0;
+  /// Returns the group identifier of this result
+  virtual std::string groupName()
+  {
+    return group();
+  }
 
   /// Request for initialization of data model of the feature: adding all attributes
-  MODELAPI_EXPORT virtual void initAttributes() = 0;
-
-  /// Computes or recomputes the result
-  MODELAPI_EXPORT virtual void execute() = 0;
-
-  /// Returns true if this feature must be displayed in the history (top level of Part tree)
-  MODELAPI_EXPORT virtual bool isInHistory() {return true;}
+  virtual void initAttributes() = 0;
+
+  /// Computes or recomputes the results
+  virtual void execute() = 0;
+
+  /// Registers error during the execution, causes the ExecutionFailed state
+  virtual void setError(const std::string& theError) {
+    data()->setError(theError);
+  }
+
+  /// returns the current results of the feature
+  MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_Result> >& results();
+  /// returns the first result in the list or NULL reference
+  MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> firstResult();
+  /// returns the last result in the list or NULL reference
+  MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> lastResult();
+  /// sets the alone result
+  MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult);
+  /// sets the result by index (zero based), results before this must be set before
+  MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
+                                 const int theIndex);
+  /// removes the result from the feature
+  MODELAPI_EXPORT void removeResult(const std::shared_ptr<ModelAPI_Result>& theResult);
+  /// removes all results from the feature
+  MODELAPI_EXPORT void eraseResults();
+  /// removes all fields from this feature: results, data, etc
+  MODELAPI_EXPORT virtual void erase();
+
+  /// Returns true if result is persistent (stored in document) and on undo-redo, save-open
+  /// it is not needed to recompute it.
+  virtual bool isPersistentResult() {return true;}
 
   /// Returns true if this feature must not be created: this is just an action
-  /// that is not stored in the features history (like delete part).
-  MODELAPI_EXPORT virtual bool isAction() {return false;}
-
-  /// Returns the data manager of this feature
-  MODELAPI_EXPORT virtual boost::shared_ptr<ModelAPI_Data> data() {return myData;}
+  /// that is not stored in the features history and data model (like "delete part").
+  virtual bool isAction()
+  {
+    return false;
+  }
 
   /// Must return document where the new feature must be added to
   /// By default it is current document
-  MODELAPI_EXPORT virtual boost::shared_ptr<ModelAPI_Document> documentToAdd()
-  {return ModelAPI_PluginManager::get()->currentDocument();}
-
-  /// Returns document this feature belongs to
-  MODELAPI_EXPORT virtual boost::shared_ptr<ModelAPI_Document> document()
-  {return myDoc;}
+  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> documentToAdd();
 
   /// To virtually destroy the fields of successors
-  virtual ~ModelAPI_Feature() {}
-
-protected:
-  /// Use plugin manager for features creation: this method is 
-  /// defined here only for SWIG-wrapping
-  ModelAPI_Feature()
-  {}
-
-  /// Sets the data manager of an object (document does)
-  MODELAPI_EXPORT virtual void setData(boost::shared_ptr<ModelAPI_Data> theData) 
-  {myData = theData;}
-  /// Sets the data manager of an object (document does)
-  MODELAPI_EXPORT void setDoc(boost::shared_ptr<ModelAPI_Document> theDoc) {myDoc = theDoc;}
-
-  friend class Model_Document;
+  MODELAPI_EXPORT virtual ~ModelAPI_Feature();
+
+  MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
+
+ //
+ // Helper methods, aliases for data()->method()
+ // -----------------------------------------------------------------------------------------------
+  inline std::string name()
+  {
+    return data()->name();
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID)
+  {
+    return data()->boolean(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID)
+  {
+    return data()->document(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID)
+  {
+    return data()->real(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID)
+  {
+    return data()->integer(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
+  {
+    return data()->refattr(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
+  {
+    return data()->reference(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID)
+  {
+    return data()->reflist(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID)
+  {
+    return data()->selection(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeSelectionList> selectionList(const std::string& theID)
+  {
+    return data()->selectionList(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID)
+  {
+    return data()->string(theID);
+  }
+
+  inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
+  {
+    return data()->attribute(theID);
+  }
+ // -----------------------------------------------------------------------------------------------
 };
 
 //! Pointer on feature object
-typedef boost::shared_ptr<ModelAPI_Feature> FeaturePtr;
-
+typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;
 
 #endif
+