src/ModelAPI/ModelAPI_Feature.h

   1 // Copyright (C) 2014-2017  CEA/DEN, EDF R&D
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  18 //
  19
  20 #ifndef ModelAPI_Feature_H_
  21 #define ModelAPI_Feature_H_
  22
  23 #include <ModelAPI.h>
  24 #include <ModelAPI_Object.h>
  25 #include <ModelAPI_Data.h>
  26 #include <ModelAPI_Document.h>
  27
  28 #include <memory>
  29
  30 #include <list>
  31 #include <string>
  32
  33 /**\class ModelAPI_Feature
  34  * \ingroup DataModel
  35  * \brief Feature function that represents the particular functionality
  36  * of this operation. Produces results by the arguments.
  37  */
  38 class ModelAPI_Feature : public ModelAPI_Object
  39 {
  40   ///< list of current results of this feature
  41   std::list<std::shared_ptr<ModelAPI_Result> > myResults;
  42   ///< is feature disabled or not
  43   bool myIsDisabled;
  44   ///< is feature is stable (not editing)
  45   bool myIsStable;
  46
  47  public:
  48   /// Returns the unique kind of a feature (like "Point")
  49   virtual const std::string& getKind() = 0;
  50
  51   /// Returns the group identifier of all features
  52   inline static std::string group()
  53   {
  54     static std::string MY_GROUP = "Features";
  55     return MY_GROUP;
  56   }
  57
  58   /// Returns document this feature belongs to
  59   virtual std::shared_ptr<ModelAPI_Document> document() const
  60   {
  61     return ModelAPI_Object::document();
  62   }
  63
  64   /// Returns the group identifier of this result
  65   virtual std::string groupName()
  66   {
  67     return group();
  68   }
  69
  70   /// Computes or recomputes the results
  71   virtual void execute() = 0;
  72
  73   /// Computes the attribute value on the base of other attributes if the value can be computed
  74   /// \param theAttributeId an attribute index to be computed
  75   /// \return a boolean value about it is computed
  76   virtual bool compute(const std::string& theAttributeId) { return false; };
  77
  78   /// Registers error during the execution, causes the ExecutionFailed state
  79   MODELAPI_EXPORT virtual void setError(const std::string& theError,
  80                                         bool isSend = true,
  81                                         bool isTranslate = true);
  82
  83   /// Returns error, arose during the execution
  84   virtual std::string error() const {
  85     return data()->error();
  86   }
  87
  88   /// returns the current results of the feature
  89   MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_Result> >& results();
  90   /// returns the first result in the list or NULL reference
  91   MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> firstResult() const;
  92   /// returns the last result in the list or NULL reference
  93   MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> lastResult();
  94   /// sets the alone result
  95   MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult);
  96   /// sets the result by index (zero based), results before this must be set before
  97   MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
  98                                  const int theIndex);
  99   /// removes the result from the feature
 100   MODELAPI_EXPORT void removeResult(const std::shared_ptr<ModelAPI_Result>& theResult);
 101   /// removes all results starting from the given index (zero-based)
 102   /// \param theSinceIndex - index of the deleted result and all after also will be deleted
 103   /// \param theForever - removes results for long period (not just because of feature disabling)
 104   /// \param theFlush - if it is false, REDISPLAY message is not flushed
 105   MODELAPI_EXPORT void removeResults(const int theSinceIndex,
 106     const bool theForever = true, const bool theFlush = true);
 107   /// removes all results from the feature
 108   MODELAPI_EXPORT void eraseResults(const bool theForever = true);
 109   /// removes all fields from this feature: results, data, etc
 110   MODELAPI_EXPORT virtual void erase();
 111   /// removes the result from the list of feature (not doing in disabled): normally this
 112   /// method is not used from features. only internally
 113   MODELAPI_EXPORT void eraseResultFromList(const std::shared_ptr<ModelAPI_Result>& theResult);
 114
 115   /// Returns true if result is persistent (stored in document) and on undo-redo, save-open
 116   /// it is not needed to recompute it.
 117   virtual bool isPersistentResult() {return true;}
 118
 119   /// Returns true if this feature must not be created: this is just an action
 120   /// that is not stored in the features history and data model (like "delete part").
 121   virtual bool isAction()
 122   {
 123     return false;
 124   }
 125
 126   /// Returns true if this feature is used as macro: creates other features and then removed.
 127   /// \returns false by default
 128   MODELAPI_EXPORT virtual bool isMacro() const;
 129
 130   /// Returns true if preview update during the edition needed. Otherwise the update-mechanism
 131   /// calls the \a execute function only on "apply" of the operation
 132   /// \returns true by default
 133   MODELAPI_EXPORT virtual bool isPreviewNeeded() const;
 134
 135   /// Must return document where the new feature must be added to
 136   /// By default it is empty: it is added to the document this method is called to
 137   MODELAPI_EXPORT virtual const std::string& documentToAdd();
 138
 139   /// Enables/disables the feature. The disabled feature has no results and does not participate in
 140   /// any calculation.
 141   /// \returns true if state is really changed
 142   MODELAPI_EXPORT virtual bool setDisabled(const bool theFlag);
 143
 144   /// Returns the feature is disabled or not.
 145   MODELAPI_EXPORT virtual bool isDisabled();
 146
 147   /// To virtually destroy the fields of successors
 148   MODELAPI_EXPORT virtual ~ModelAPI_Feature();
 149
 150   /// Returns the feature by the object (result).
 151   MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
 152
 153   /// Set the stable feature flag. If feature is currently editing then it is not stable.
 154   /// \returns true if state is really changed
 155   MODELAPI_EXPORT virtual bool setStable(const bool theFlag);
 156
 157   /// Returns the feature is stable or not.
 158   MODELAPI_EXPORT virtual bool isStable();
 159
 160   /// Performs some custom feature specific functionality (normally called by some GUI button)
 161   /// \param theActionId an action key
 162   /// \return a boolean value about it is performed
 163   MODELAPI_EXPORT virtual bool customAction(const std::string& theActionId);
 164
 165  //
 166  // Helper methods, aliases for data()->method()
 167  // -----------------------------------------------------------------------------------------------
 168   /// Returns the name stored in the attribute
 169   inline std::string name()
 170   {
 171     return data()->name();
 172   }
 173   /// Returns the Boolean attribute by the identifier
 174   inline std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID)
 175   {
 176     return data()->boolean(theID);
 177   }
 178   /// Returns the document reference attribute
 179   inline std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID)
 180   {
 181     return data()->document(theID);
 182   }
 183   /// Returns the real attribute by the identifier
 184   inline std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID)
 185   {
 186     return data()->real(theID);
 187   }
 188   /// Returns the integer attribute by the identifier
 189   inline std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID)
 190   {
 191     return data()->integer(theID);
 192   }
 193   /// Returns the integer array attribute by the identifier
 194   inline std::shared_ptr<ModelAPI_AttributeIntArray> intArray(const std::string& theID)
 195   {
 196     return data()->intArray(theID);
 197   }
 198   /// Returns the reference attribute by the identifier
 199   inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
 200   {
 201     return data()->refattr(theID);
 202   }
 203   /// Returns the reference attribute by the identifier
 204   inline std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
 205   {
 206     return data()->reference(theID);
 207   }
 208   /// Returns the list of references attribute by the identifier
 209   inline std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID)
 210   {
 211     return data()->reflist(theID);
 212   }
 213   /// Returns the shape selection attribute by the identifier
 214   inline std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID)
 215   {
 216     return data()->selection(theID);
 217   }
 218   /// Returns the list of shape selections attribute by the identifier
 219   inline std::shared_ptr<ModelAPI_AttributeSelectionList> selectionList(const std::string& theID)
 220   {
 221     return data()->selectionList(theID);
 222   }
 223   /// Returns the string attribute by the identifier
 224   inline std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID)
 225   {
 226     return data()->string(theID);
 227   }
 228   /// Returns the string array attribute by the identifier
 229   inline std::shared_ptr<ModelAPI_AttributeStringArray> stringArray(const std::string& theID)
 230   {
 231     return data()->stringArray(theID);
 232   }
 233   /// Returns the tables attribute by the identifier
 234   inline std::shared_ptr<ModelAPI_AttributeTables> tables(const std::string& theID)
 235   {
 236     return data()->tables(theID);
 237   }
 238   /// Returns the attribute by the identifier
 239   inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
 240   {
 241     return data()->attribute(theID);
 242   }
 243   protected:
 244   /// This method is called just after creation of the object: it must initialize
 245   /// all fields, normally initialized in the constructor
 246   MODELAPI_EXPORT virtual void init();
 247
 248   friend class Model_Document;
 249   friend class Model_Objects;
 250 };
 251
 252 //! Pointer on feature object
 253 typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;
 254
 255 #endif
 256