X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Feature.h;h=8a648e7c53c21616a7260ed5ad29ec0d11f2628c;hb=4587841469935cb1a28754558dece0ee77aa20a6;hp=2305044edd546e0905e5e07d2d6b8daff88dba3f;hpb=db1bdf5481826c868b2c92c6cbc9afe8c5ad337c;p=modules%2Fshaper.git

diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h
index 2305044ed..8a648e7c5 100644
--- a/src/ModelAPI/ModelAPI_Feature.h
+++ b/src/ModelAPI/ModelAPI_Feature.h
@@ -1,20 +1,21 @@
+// 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_Object.h"
-#include "ModelAPI_PluginManager.h"
+#include <ModelAPI.h>
+#include <ModelAPI_Object.h>
+#include <ModelAPI_Data.h>
+#include <ModelAPI_Document.h>
 
-#include <string>
-#include <list>
-#include <boost/shared_ptr.hpp>
+#include <memory>
 
-class ModelAPI_Data;
-class ModelAPI_Document;
-class ModelAPI_Result;
+#include <list>
+#include <string>
 
 /**\class ModelAPI_Feature
  * \ingroup DataModel
@@ -24,44 +25,197 @@ class ModelAPI_Result;
 class ModelAPI_Feature : public ModelAPI_Object
 {
   ///< list of current results of this feature
-  std::list<boost::shared_ptr<ModelAPI_Result> > myResults;
-public:
+  std::list<std::shared_ptr<ModelAPI_Result> > myResults;
+  ///< is feature disabled or not
+  bool myIsDisabled;
+  ///< is feature is stable (not editing)
+  bool myIsStable;
+
+ 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;}
+  inline static std::string group()
+  {
+    static std::string MY_GROUP = "Features";
+    return MY_GROUP;
+  }
 
-  /// Returns the group identifier of this result
-  virtual std::string groupName() { return group(); }
+  /// Returns document this feature belongs to
+  virtual std::shared_ptr<ModelAPI_Document> document() const
+  {
+    return ModelAPI_Object::document();
+  }
 
-  /// Request for initialization of data model of the feature: adding all attributes
-  virtual void initAttributes() = 0;
+  /// Returns the group identifier of this result
+  virtual std::string groupName()
+  {
+    return group();
+  }
 
   /// Computes or recomputes the results
   virtual void execute() = 0;
 
+  /// Computes the attribute value on the base of other attributes if the value can be computed
+  /// \param theAttributeId an attribute index to be computed
+  /// \return a boolean value about it is computed
+  virtual bool compute(const std::string& theAttributeId) { return false; };
+
+  /// Registers error during the execution, causes the ExecutionFailed state
+  virtual void setError(const std::string& theError, bool isSend = true) {
+    data()->setError(theError, isSend);
+  }
+
+  /// Returns error, arose during the execution
+  virtual std::string error() const {
+    return data()->error();
+  }
+
   /// returns the current results of the feature
-  MODELAPI_EXPORT const std::list<boost::shared_ptr<ModelAPI_Result> >& results();
+  MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_Result> >& results();
   /// returns the first result in the list or NULL reference
-  MODELAPI_EXPORT boost::shared_ptr<ModelAPI_Result> firstResult();
+  MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> firstResult() const;
+  /// 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 boost::shared_ptr<ModelAPI_Result>& theResult);
+  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 starting from the given index (zero-based)
+  /// \param theSinceIndex - index of the deleted result and all after also will be deleted
+  /// \param theFlush - if it is false, REDISPLAY message is not flushed
+  MODELAPI_EXPORT void removeResults(const int theSinceIndex, const bool theFlush = true);
+  /// removes all results from the feature
+  MODELAPI_EXPORT void eraseResults();
+  /// removes all fields from this feature: results, data, etc
+  MODELAPI_EXPORT virtual void erase();
+  /// removes the result from the list of feature (not doing in disabled): normally this
+  /// method is not used from features. only internally
+  MODELAPI_EXPORT void eraseResultFromList(const std::shared_ptr<ModelAPI_Result>& theResult);
+
+  /// 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 and data model (like "delete part").
-  virtual bool isAction() {return false;}
+  virtual bool isAction()
+  {
+    return false;
+  }
+
+  /// Returns true if this feature is used as macro: creates other features and then removed.
+  /// \returns false by default
+  MODELAPI_EXPORT virtual bool isMacro() const;
+
+  /// Returns true if preview update during the edition needed. Otherwise the update-mechanism
+  /// calls the \a execute function only on "apply" of the operation
+  /// \returns true by default
+  MODELAPI_EXPORT virtual bool isPreviewNeeded() const;
 
   /// 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();
+  /// By default it is empty: it is added to the document this method is called to
+  MODELAPI_EXPORT virtual const std::string& documentToAdd();
+
+  /// Enables/disables the feature. The disabled feature has no results and does not participate in
+  /// any calculation.
+  /// \returns true if state is really changed
+  MODELAPI_EXPORT virtual bool setDisabled(const bool theFlag);
+
+  /// Returns the feature is disabled or not.
+  MODELAPI_EXPORT virtual bool isDisabled();
 
   /// To virtually destroy the fields of successors
   MODELAPI_EXPORT virtual ~ModelAPI_Feature();
+
+  /// Returns the feature by the object (result).
+  MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
+
+  /// Set the stable feature flag. If feature is currently editing then it is not stable.
+  /// \returns true if state is really changed
+  MODELAPI_EXPORT virtual bool setStable(const bool theFlag);
+
+  /// Returns the feature is stable or not.
+  MODELAPI_EXPORT virtual bool isStable();
+
+ //
+ // Helper methods, aliases for data()->method()
+ // -----------------------------------------------------------------------------------------------
+  /// Returns the name stored in the attribute
+  inline std::string name()
+  {
+    return data()->name();
+  }
+  /// Returns the Boolean attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID)
+  {
+    return data()->boolean(theID);
+  }
+  /// Returns the document reference attribute
+  inline std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID)
+  {
+    return data()->document(theID);
+  }
+  /// Returns the real attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID)
+  {
+    return data()->real(theID);
+  }
+  /// Returns the integer attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID)
+  {
+    return data()->integer(theID);
+  }
+  /// Returns the reference attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
+  {
+    return data()->refattr(theID);
+  }
+  /// Returns the reference attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
+  {
+    return data()->reference(theID);
+  }
+  /// Returns the list of references attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID)
+  {
+    return data()->reflist(theID);
+  }
+  /// Returns the shape selection attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID)
+  {
+    return data()->selection(theID);
+  }
+  /// Returns the list of shape selections attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeSelectionList> selectionList(const std::string& theID)
+  {
+    return data()->selectionList(theID);
+  }
+  /// Returns the string attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID)
+  {
+    return data()->string(theID);
+  }
+  /// Returns the attribute by the identifier
+  inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
+  {
+    return data()->attribute(theID);
+  }
+  protected:
+  /// This method is called just after creation of the object: it must initialize
+  /// all fields, normally initialized in the constructor
+  MODELAPI_EXPORT virtual void init();
+
+  friend class Model_Document;
+  friend class Model_Objects;
 };
 
 //! Pointer on feature object
-typedef boost::shared_ptr<ModelAPI_Feature> FeaturePtr;
+typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;
 
 #endif
+