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 /// Request for initialization of data model of the feature: adding all attributes
53 virtual void initAttributes() = 0;
55 /// Computes or recomputes the results
56 virtual void execute() = 0;
58 /// Registers error during the execution, causes the ExecutionFailed state
59 virtual void setError(const std::string& theError) {
60 data()->setError(theError);
63 /// returns the current results of the feature
64 MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_Result> >& results();
65 /// returns the first result in the list or NULL reference
66 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> firstResult();
67 /// returns the last result in the list or NULL reference
68 MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> lastResult();
69 /// sets the alone result
70 MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult);
71 /// sets the result by index (zero based), results before this must be set before
72 MODELAPI_EXPORT void setResult(const std::shared_ptr<ModelAPI_Result>& theResult,
74 /// removes the result from the feature
75 MODELAPI_EXPORT void removeResult(const std::shared_ptr<ModelAPI_Result>& theResult);
76 /// removes all results from the feature
77 MODELAPI_EXPORT void eraseResults();
78 /// removes all fields from this feature: results, data, etc
79 MODELAPI_EXPORT virtual void erase();
81 /// Returns true if result is persistent (stored in document) and on undo-redo, save-open
82 /// it is not needed to recompute it.
83 virtual bool isPersistentResult() {return true;}
85 /// Returns true if this feature must not be created: this is just an action
86 /// that is not stored in the features history and data model (like "delete part").
87 virtual bool isAction()
92 /// Must return document where the new feature must be added to
93 /// By default it is current document
94 MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> documentToAdd();
96 /// To virtually destroy the fields of successors
97 MODELAPI_EXPORT virtual ~ModelAPI_Feature();
99 /// Returns the feature by the object (result).
100 MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
103 // Helper methods, aliases for data()->method()
104 // -----------------------------------------------------------------------------------------------
105 /// Returns the name stored in the attribute
106 inline std::string name()
108 return data()->name();
110 /// Returns the Boolean attribute by the identifier
111 inline std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID)
113 return data()->boolean(theID);
115 /// Returns the document reference attribute
116 inline std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID)
118 return data()->document(theID);
120 /// Returns the real attribute by the identifier
121 inline std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID)
123 return data()->real(theID);
125 /// Returns the integer attribute by the identifier
126 inline std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID)
128 return data()->integer(theID);
130 /// Returns the reference attribute by the identifier
131 inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
133 return data()->refattr(theID);
135 /// Returns the reference attribute by the identifier
136 inline std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
138 return data()->reference(theID);
140 /// Returns the list of references attribute by the identifier
141 inline std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID)
143 return data()->reflist(theID);
145 /// Returns the shape selection attribute by the identifier
146 inline std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID)
148 return data()->selection(theID);
150 /// Returns the list of shape selections attribute by the identifier
151 inline std::shared_ptr<ModelAPI_AttributeSelectionList> selectionList(const std::string& theID)
153 return data()->selectionList(theID);
155 /// Returns the string attribute by the identifier
156 inline std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID)
158 return data()->string(theID);
160 /// Returns the attribute by the identifier
161 inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
163 return data()->attribute(theID);
165 // -----------------------------------------------------------------------------------------------
168 //! Pointer on feature object
169 typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;