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;
30 /// Returns the unique kind of a feature (like "Point")
31 virtual const std::string& getKind() = 0;
33 /// Returns the group identifier of all features
34 inline static std::string group()
36 static std::string MY_GROUP = "Features";
40 /// Returns document this feature belongs to
41 virtual std::shared_ptr<ModelAPI_Document> document() const
43 return ModelAPI_Object::document();
46 /// Returns the group identifier of this result
47 virtual std::string groupName()
52 /// Computes or recomputes the results
53 virtual void execute() = 0;
55 /// Computes the attribute value on the base of other attributes if the value can be computed
56 /// \param theAttributeId an attribute index to be computed
57 /// \return a boolean value about it is computed
58 virtual bool compute(const std::string& theAttributeId) { return false; };
60 /// Registers error during the execution, causes the ExecutionFailed state
61 virtual void setError(const std::string& theError, bool isSend = true) {
62 data()->setError(theError, isSend);
65 /// Returns error, arose during the execution
66 virtual std::string error() const {
67 return data()->error();
70 /// returns the current results of the feature
71 MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_Result> >& results();
72 /// returns the first result in the list or NULL reference
73 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> firstResult();
74 /// returns the last result in the list or NULL reference
75 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> lastResult();
76 /// sets the alone result
77 MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult);
78 /// sets the result by index (zero based), results before this must be set before
79 MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
81 /// removes the result from the feature
82 MODELAPI_EXPORT void removeResult(const std::shared_ptr<ModelAPI_Result>& theResult);
83 /// removes all results starting from the gived index (zero-based)
84 MODELAPI_EXPORT void removeResults(const int theSinceIndex);
85 /// removes all results from the feature
86 MODELAPI_EXPORT void eraseResults();
87 /// removes all fields from this feature: results, data, etc
88 MODELAPI_EXPORT virtual void erase();
90 /// Returns true if result is persistent (stored in document) and on undo-redo, save-open
91 /// it is not needed to recompute it.
92 virtual bool isPersistentResult() {return true;}
94 /// Returns true if this feature must not be created: this is just an action
95 /// that is not stored in the features history and data model (like "delete part").
96 virtual bool isAction()
101 /// Returns true if this feature is used as macro: creates other features and then removed.
102 /// \returns false by default
103 MODELAPI_EXPORT virtual bool isMacro() const;
105 /// Must return document where the new feature must be added to
106 /// By default it is empty: it is added to the document this method is called to
107 MODELAPI_EXPORT virtual const std::string& documentToAdd();
109 /// To virtually destroy the fields of successors
110 MODELAPI_EXPORT virtual ~ModelAPI_Feature();
112 /// Returns the feature by the object (result).
113 MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
116 // Helper methods, aliases for data()->method()
117 // -----------------------------------------------------------------------------------------------
118 /// Returns the name stored in the attribute
119 inline std::string name()
121 return data()->name();
123 /// Returns the Boolean attribute by the identifier
124 inline std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID)
126 return data()->boolean(theID);
128 /// Returns the document reference attribute
129 inline std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID)
131 return data()->document(theID);
133 /// Returns the real attribute by the identifier
134 inline std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID)
136 return data()->real(theID);
138 /// Returns the integer attribute by the identifier
139 inline std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID)
141 return data()->integer(theID);
143 /// Returns the reference attribute by the identifier
144 inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
146 return data()->refattr(theID);
148 /// Returns the reference attribute by the identifier
149 inline std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
151 return data()->reference(theID);
153 /// Returns the list of references attribute by the identifier
154 inline std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID)
156 return data()->reflist(theID);
158 /// Returns the shape selection attribute by the identifier
159 inline std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID)
161 return data()->selection(theID);
163 /// Returns the list of shape selections attribute by the identifier
164 inline std::shared_ptr<ModelAPI_AttributeSelectionList> selectionList(const std::string& theID)
166 return data()->selectionList(theID);
168 /// Returns the string attribute by the identifier
169 inline std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID)
171 return data()->string(theID);
173 /// Returns the attribute by the identifier
174 inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
176 return data()->attribute(theID);
178 // -----------------------------------------------------------------------------------------------
181 //! Pointer on feature object
182 typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;