#ifndef ModelAPI_Feature_HeaderFile
#define ModelAPI_Feature_HeaderFile
-#include "ModelAPI.h"
+#include "ModelAPI_Object.h"
+#include "ModelAPI_PluginManager.h"
+
#include <string>
-#include <memory>
+#include <list>
+#include <boost/shared_ptr.hpp>
-class ModelAPI_Object;
+class ModelAPI_Data;
+class ModelAPI_Document;
+class ModelAPI_Result;
/**\class ModelAPI_Feature
* \ingroup DataModel
- * \brief Functionality of the model object: to update result,
- * to initialize attributes, etc.
+ * \brief Feature function that represents the particular functionality
+ * of this operation. Produces results by the arguments.
*/
-
-class MODELAPI_EXPORT ModelAPI_Feature
+class ModelAPI_Feature : public ModelAPI_Object
{
- std::shared_ptr<ModelAPI_Object> myData; ///< manager of the data model of a feature
-
+ ///< list of current results of this feature
+ std::list<boost::shared_ptr<ModelAPI_Result> > myResults;
public:
- /// Returns the kind of a feature (like "Point")
- virtual std::string getKind() = 0;
+ /// Returns the unique kind of a feature (like "Point")
+ virtual const std::string& getKind() = 0;
+
+ /// Returns the group identifier of all features
+ static std::string group()
+ {static std::string MY_GROUP = "Features"; return MY_GROUP;}
+
+ /// Returns the group identifier of this result
+ virtual std::string groupName() { return group(); }
/// Request for initialization of data model of the feature: adding all attributes
virtual void initAttributes() = 0;
- /// Computes or recomputes the result
+ /// Computes or recomputes the results
virtual void execute() = 0;
- /// Returns the data manager of this feature
- std::shared_ptr<ModelAPI_Object> data() {return myData;}
+ /// returns the current results of the feature
+ MODELAPI_EXPORT const std::list<boost::shared_ptr<ModelAPI_Result> >& results();
+ /// returns the first result in the list or NULL reference
+ MODELAPI_EXPORT boost::shared_ptr<ModelAPI_Result> firstResult();
+ /// sets the alone result
+ MODELAPI_EXPORT void setResult(const boost::shared_ptr<ModelAPI_Result>& theResult);
+
+ /// Returns true if this feature must not be created: this is just an action
+ /// that is not stored in the features history and data model (like "delete part").
+ virtual bool isAction() {return false;}
-protected:
- /// Use plugin manager for features creation: this method is
- /// defined here only for SWIG-wrapping
- ModelAPI_Feature()
- {}
+ /// Must return document where the new feature must be added to
+ /// By default it is current document
+ MODELAPI_EXPORT virtual boost::shared_ptr<ModelAPI_Document> documentToAdd();
- /// Sets the data manager of an object (document does)
- void setData(std::shared_ptr<ModelAPI_Object> theData) {myData = theData;}
- friend class Model_Document;
+ /// To virtually destroy the fields of successors
+ MODELAPI_EXPORT virtual ~ModelAPI_Feature();
};
+//! Pointer on feature object
+typedef boost::shared_ptr<ModelAPI_Feature> FeaturePtr;
+
#endif
