X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Feature.h;h=66eb18225d371b0cd2ba02b94a0b50581c36a0dc;hb=09dabb6acd9664f589a0bd9415d804d7a37ab801;hp=452686cdb20906749a9c312f2a720c0a32121adc;hpb=7bf19255421b34594c7b0a76d0ce28166d0ce895;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h index 452686cdb..66eb18225 100644 --- a/src/ModelAPI/ModelAPI_Feature.h +++ b/src/ModelAPI/ModelAPI_Feature.h @@ -26,12 +26,17 @@ class ModelAPI_Feature : public ModelAPI_Object { ///< list of current results of this feature std::list > 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() + inline static std::string group() { static std::string MY_GROUP = "Features"; return MY_GROUP; @@ -49,21 +54,28 @@ class ModelAPI_Feature : public ModelAPI_Object return group(); } - /// Request for initialization of data model of the feature: adding all attributes - virtual void initAttributes() = 0; - /// 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) { - data()->setError(theError); + 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 >& results(); /// returns the first result in the list or NULL reference - MODELAPI_EXPORT std::shared_ptr firstResult(); + MODELAPI_EXPORT std::shared_ptr firstResult() const; /// returns the last result in the list or NULL reference MODELAPI_EXPORT std::shared_ptr lastResult(); /// sets the alone result @@ -73,10 +85,17 @@ class ModelAPI_Feature : public ModelAPI_Object const int theIndex); /// removes the result from the feature MODELAPI_EXPORT void removeResult(const std::shared_ptr& 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& theResult); /// Returns true if result is persistent (stored in document) and on undo-redo, save-open /// it is not needed to recompute it. @@ -89,78 +108,115 @@ class ModelAPI_Feature : public ModelAPI_Object 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 std::shared_ptr 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 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(); + + /// Performs some custom feature specific functionality (normally called by some GUI button) + /// \param theActionId an action key + /// \return a boolean value about it is performed + MODELAPI_EXPORT virtual bool customAction(const std::string& theActionId); + // // 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 boolean(const std::string& theID) { return data()->boolean(theID); } - + /// Returns the document reference attribute inline std::shared_ptr document(const std::string& theID) { return data()->document(theID); } - + /// Returns the real attribute by the identifier inline std::shared_ptr real(const std::string& theID) { return data()->real(theID); } - + /// Returns the integer attribute by the identifier inline std::shared_ptr integer(const std::string& theID) { return data()->integer(theID); } - + /// Returns the reference attribute by the identifier inline std::shared_ptr refattr(const std::string& theID) { return data()->refattr(theID); } - + /// Returns the reference attribute by the identifier inline std::shared_ptr reference(const std::string& theID) { return data()->reference(theID); } - + /// Returns the list of references attribute by the identifier inline std::shared_ptr reflist(const std::string& theID) { return data()->reflist(theID); } - + /// Returns the shape selection attribute by the identifier inline std::shared_ptr selection(const std::string& theID) { return data()->selection(theID); } - + /// Returns the list of shape selections attribute by the identifier inline std::shared_ptr selectionList(const std::string& theID) { return data()->selectionList(theID); } - + /// Returns the string attribute by the identifier inline std::shared_ptr string(const std::string& theID) { return data()->string(theID); } - + /// Returns the attribute by the identifier inline std::shared_ptr 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