#ifndef ModelAPI_Feature_HeaderFile
#define ModelAPI_Feature_HeaderFile
-#include "ModelAPI.h"
+#include "ModelAPI_Object.h"
#include "ModelAPI_PluginManager.h"
#include <string>
+#include <list>
#include <boost/shared_ptr.hpp>
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_Feature
+class ModelAPI_Feature : public ModelAPI_Object
{
- boost::shared_ptr<ModelAPI_Data> myData; ///< manager of the data model of a feature
- boost::shared_ptr<ModelAPI_Document> myDoc; ///< document this feature belongs to
-
+ ///< list of current results of this feature
+ std::list<boost::shared_ptr<ModelAPI_Result> > myResults;
public:
- /// Returns the kind of a feature (like "Point")
- MODELAPI_EXPORT virtual const 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 to which group in the document must be added feature
- MODELAPI_EXPORT virtual const std::string& getGroup() = 0;
+ /// 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
- MODELAPI_EXPORT virtual void initAttributes() = 0;
+ virtual void initAttributes() = 0;
- /// Computes or recomputes the result
- MODELAPI_EXPORT virtual void execute() = 0;
+ /// Computes or recomputes the results
+ virtual void execute() = 0;
- /// Returns true if this feature must be displayed in the history (top level of Part tree)
- MODELAPI_EXPORT virtual bool isInHistory() {return true;}
+ /// 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);
- /// Returns the data manager of this feature
- MODELAPI_EXPORT virtual boost::shared_ptr<ModelAPI_Data> data() {return myData;}
+ /// 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()
- {return ModelAPI_PluginManager::get()->currentDocument();}
-
- /// Returns document this feature belongs to
- MODELAPI_EXPORT virtual boost::shared_ptr<ModelAPI_Document> document()
- {return myDoc;}
+ MODELAPI_EXPORT virtual boost::shared_ptr<ModelAPI_Document> documentToAdd();
/// To virtually destroy the fields of successors
- virtual ~ModelAPI_Feature() {}
-
-protected:
- /// Use plugin manager for features creation: this method is
- /// defined here only for SWIG-wrapping
- ModelAPI_Feature()
- {}
-
- /// Sets the data manager of an object (document does)
- MODELAPI_EXPORT virtual void setData(boost::shared_ptr<ModelAPI_Data> theData)
- {myData = theData;}
- /// Sets the data manager of an object (document does)
- MODELAPI_EXPORT void setDoc(boost::shared_ptr<ModelAPI_Document> theDoc) {myDoc = theDoc;}
-
- friend class Model_Document;
+ MODELAPI_EXPORT virtual ~ModelAPI_Feature();
};
+//! Pointer on feature object
+typedef boost::shared_ptr<ModelAPI_Feature> FeaturePtr;
+
#endif
