1 // File: ModelAPI_Feature.hxx
2 // Created: 21 Mar 2014
3 // Author: Mikhail PONIKAROV
5 #ifndef ModelAPI_Feature_H_
6 #define ModelAPI_Feature_H_
8 #include "ModelAPI_Object.h"
9 #include "ModelAPI_PluginManager.h"
13 #include <boost/shared_ptr.hpp>
16 class ModelAPI_Document;
17 class ModelAPI_Result;
19 /**\class ModelAPI_Feature
21 * \brief Feature function that represents the particular functionality
22 * of this operation. Produces results by the arguments.
24 class ModelAPI_Feature : public ModelAPI_Object
26 ///< list of current results of this feature
27 std::list<boost::shared_ptr<ModelAPI_Result> > myResults;
29 /// Returns the unique kind of a feature (like "Point")
30 virtual const std::string& getKind() = 0;
32 /// Returns the group identifier of all features
33 static std::string group()
35 static std::string MY_GROUP = "Features";
39 /// Returns the group identifier of this result
40 virtual std::string groupName()
45 /// Request for initialization of data model of the feature: adding all attributes
46 virtual void initAttributes() = 0;
48 /// Computes or recomputes the results
49 virtual void execute() = 0;
51 /// returns the current results of the feature
52 MODELAPI_EXPORT const std::list<boost::shared_ptr<ModelAPI_Result> >& results();
53 /// returns the first result in the list or NULL reference
54 MODELAPI_EXPORT boost::shared_ptr<ModelAPI_Result> firstResult();
55 /// sets the alone result
56 MODELAPI_EXPORT void setResult(const boost::shared_ptr<ModelAPI_Result>& theResult);
57 /// sets the result by index (zero based), results before this must be set before
58 MODELAPI_EXPORT void setResult(const boost::shared_ptr<ModelAPI_Result>& theResult,
61 /// Returns true if result is persistent (stored in document) and on undo-redo, save-open
62 /// it is not needed to recompute it.
63 virtual bool isPersistentResult() {return true;}
65 /// Returns true if this feature must not be created: this is just an action
66 /// that is not stored in the features history and data model (like "delete part").
67 virtual bool isAction()
72 /// Must return document where the new feature must be added to
73 /// By default it is current document
74 MODELAPI_EXPORT virtual boost::shared_ptr<ModelAPI_Document> documentToAdd();
76 /// To virtually destroy the fields of successors
77 MODELAPI_EXPORT virtual ~ModelAPI_Feature();
79 MODELAPI_EXPORT static boost::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
83 //! Pointer on feature object
84 typedef boost::shared_ptr<ModelAPI_Feature> FeaturePtr;