// Created: 21 Mar 2014
// Author: Mikhail PONIKAROV
-#ifndef ModelAPI_Feature_HeaderFile
-#define ModelAPI_Feature_HeaderFile
+#ifndef ModelAPI_Feature_H_
+#define ModelAPI_Feature_H_
+
+#include "ModelAPI_Object.h"
+#include "ModelAPI_Session.h"
-#include "ModelAPI.h"
#include <string>
+#include <list>
+#include <boost/shared_ptr.hpp>
-class ModelAPI_Feature;
+class ModelAPI_Data;
+class ModelAPI_Document;
+class ModelAPI_Result;
/**\class ModelAPI_Feature
* \ingroup DataModel
- * \brief General object of the application that allows
- * to get/set attributes from the document and compute result of an operation.
+ * \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
{
-public:
- /// Returns the kind of a feature (like "Point")
- virtual std::string GetKind() = 0;
+ ///< list of current results of this feature
+ std::list<boost::shared_ptr<ModelAPI_Result> > myResults;
+ public:
+ /// 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;
+ }
- /// Use plugin manager for features creation: this method is
- /// defined here only for SWIG-wrapping
- ModelAPI_Feature()
+ /// 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 results
+ virtual void execute() = 0;
+
+ /// 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);
+ /// sets the result by index (zero based), results before this must be set before
+ MODELAPI_EXPORT void setResult(const boost::shared_ptr<ModelAPI_Result>& theResult,
+ const int theIndex);
+ /// removes the result from the feature
+ MODELAPI_EXPORT void removeResult(const boost::shared_ptr<ModelAPI_Result>& theResult);
+ /// removes all results from the feature
+ MODELAPI_EXPORT void eraseResults();
+ /// removes all fields from this feature: results, data, etc
+ MODELAPI_EXPORT virtual void erase();
+
+ /// Returns true if result is persistent (stored in document) and on undo-redo, save-open
+ /// it is not needed to recompute it.
+ virtual bool isPersistentResult() {return true;}
+
+ /// 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;
+ }
+
+ /// 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();
+
+ /// To virtually destroy the fields of successors
+ MODELAPI_EXPORT virtual ~ModelAPI_Feature();
+
+ MODELAPI_EXPORT static boost::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
+
};
+//! Pointer on feature object
+typedef boost::shared_ptr<ModelAPI_Feature> FeaturePtr;
+
#endif