1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_Feature.hxx
4 // Created: 21 Mar 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef ModelAPI_Feature_H_
8 #define ModelAPI_Feature_H_
11 #include <ModelAPI_Object.h>
12 #include <ModelAPI_Data.h>
13 #include <ModelAPI_Document.h>
20 /**\class ModelAPI_Feature
22 * \brief Feature function that represents the particular functionality
23 * of this operation. Produces results by the arguments.
25 class ModelAPI_Feature : public ModelAPI_Object
27 ///< list of current results of this feature
28 std::list<std::shared_ptr<ModelAPI_Result> > myResults;
29 ///< is feature disabled or not
32 /// Returns the unique kind of a feature (like "Point")
33 virtual const std::string& getKind() = 0;
35 /// Returns the group identifier of all features
36 inline static std::string group()
38 static std::string MY_GROUP = "Features";
42 /// Returns document this feature belongs to
43 virtual std::shared_ptr<ModelAPI_Document> document() const
45 return ModelAPI_Object::document();
48 /// Returns the group identifier of this result
49 virtual std::string groupName()
54 /// Computes or recomputes the results
55 virtual void execute() = 0;
57 /// Computes the attribute value on the base of other attributes if the value can be computed
58 /// \param theAttributeId an attribute index to be computed
59 /// \return a boolean value about it is computed
60 virtual bool compute(const std::string& theAttributeId) { return false; };
62 /// Registers error during the execution, causes the ExecutionFailed state
63 virtual void setError(const std::string& theError, bool isSend = true) {
64 data()->setError(theError, isSend);
67 /// Returns error, arose during the execution
68 virtual std::string error() const {
69 return data()->error();
72 /// returns the current results of the feature
73 MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_Result> >& results();
74 /// returns the first result in the list or NULL reference
75 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> firstResult() const;
76 /// returns the last result in the list or NULL reference
77 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> lastResult();
78 /// sets the alone result
79 MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult);
80 /// sets the result by index (zero based), results before this must be set before
81 MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
83 /// removes the result from the feature
84 MODELAPI_EXPORT void removeResult(const std::shared_ptr<ModelAPI_Result>& theResult);
85 /// removes all results starting from the given index (zero-based)
86 /// \param theSinceIndex - index of the deleted result and all after also will be deleted
87 /// \param theFlush - if it is false, REDISPLAY message is not flushed
88 MODELAPI_EXPORT void removeResults(const int theSinceIndex, const bool theFlush = true);
89 /// removes all results from the feature
90 MODELAPI_EXPORT void eraseResults();
91 /// removes all fields from this feature: results, data, etc
92 MODELAPI_EXPORT virtual void erase();
93 /// removes the result from the list of feature (not doing in disabled): normally this
94 /// method is not used from features. only internally
95 MODELAPI_EXPORT void eraseResultFromList(const std::shared_ptr<ModelAPI_Result>& theResult);
97 /// Returns true if result is persistent (stored in document) and on undo-redo, save-open
98 /// it is not needed to recompute it.
99 virtual bool isPersistentResult() {return true;}
101 /// Returns true if this feature must not be created: this is just an action
102 /// that is not stored in the features history and data model (like "delete part").
103 virtual bool isAction()
108 /// Returns true if this feature is used as macro: creates other features and then removed.
109 /// \returns false by default
110 MODELAPI_EXPORT virtual bool isMacro() const;
112 /// Returns true if preview update during the edition needed. Otherwise the update-mechanism
113 /// calls the \a execute function only on "apply" of the operation
114 /// \returns true by default
115 MODELAPI_EXPORT virtual bool isPreviewNeeded() const;
117 /// Must return document where the new feature must be added to
118 /// By default it is empty: it is added to the document this method is called to
119 MODELAPI_EXPORT virtual const std::string& documentToAdd();
121 /// Enables/disables the feature. The disabled feature has no results and does not participate in
123 /// \returns true if state is really changed
124 MODELAPI_EXPORT virtual bool setDisabled(const bool theFlag);
126 /// Returns the feature is disabled or not.
127 MODELAPI_EXPORT virtual bool isDisabled();
129 /// To virtually destroy the fields of successors
130 MODELAPI_EXPORT virtual ~ModelAPI_Feature();
132 /// Returns the feature by the object (result).
133 MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
136 // Helper methods, aliases for data()->method()
137 // -----------------------------------------------------------------------------------------------
138 /// Returns the name stored in the attribute
139 inline std::string name()
141 return data()->name();
143 /// Returns the Boolean attribute by the identifier
144 inline std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID)
146 return data()->boolean(theID);
148 /// Returns the document reference attribute
149 inline std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID)
151 return data()->document(theID);
153 /// Returns the real attribute by the identifier
154 inline std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID)
156 return data()->real(theID);
158 /// Returns the integer attribute by the identifier
159 inline std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID)
161 return data()->integer(theID);
163 /// Returns the reference attribute by the identifier
164 inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
166 return data()->refattr(theID);
168 /// Returns the reference attribute by the identifier
169 inline std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
171 return data()->reference(theID);
173 /// Returns the list of references attribute by the identifier
174 inline std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID)
176 return data()->reflist(theID);
178 /// Returns the shape selection attribute by the identifier
179 inline std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID)
181 return data()->selection(theID);
183 /// Returns the list of shape selections attribute by the identifier
184 inline std::shared_ptr<ModelAPI_AttributeSelectionList> selectionList(const std::string& theID)
186 return data()->selectionList(theID);
188 /// Returns the string attribute by the identifier
189 inline std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID)
191 return data()->string(theID);
193 /// Returns the attribute by the identifier
194 inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
196 return data()->attribute(theID);
199 /// This method is called just after creation of the object: it must initialize
200 /// all fields, normally initialized in the constructor
201 MODELAPI_EXPORT virtual void init();
203 friend class Model_Document;
204 friend class Model_Objects;
207 //! Pointer on feature object
208 typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;