{
///< list of current results of this feature
std::list<std::shared_ptr<ModelAPI_Result> > myResults;
+ ///< is feature disabled or not
+ bool myIsDisabled;
public:
/// Returns the unique kind of a feature (like "Point")
virtual const std::string& getKind() = 0;
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
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 gived 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.
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<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() const;
/// 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);
//
// 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);