+ /// Returns document this feature belongs to
+ virtual std::shared_ptr<ModelAPI_Document> document() const
+ {
+ return ModelAPI_Object::document();
+ }
+
+ /// 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<std::shared_ptr<ModelAPI_Result> >& results();
+ /// returns the first result in the list or NULL reference
+ 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 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;
+ }
+
+ /// 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;