+// Copyright (C) 2014-20xx CEA/DEN, EDF R&D
+
// File: ModelAPI_Feature.hxx
// Created: 21 Mar 2014
// Author: Mikhail PONIKAROV
#include <ModelAPI.h>
#include <ModelAPI_Object.h>
-#include <ModelAPI_AttributeBoolean.h>
-#include <ModelAPI_AttributeDocRef.h>
-#include <ModelAPI_AttributeDouble.h>
-#include <ModelAPI_AttributeInteger.h>
-#include <ModelAPI_AttributeRefAttr.h>
-#include <ModelAPI_AttributeReference.h>
-#include <ModelAPI_AttributeSelection.h>
-#include <ModelAPI_AttributeSelectionList.h>
-#include <ModelAPI_AttributeString.h>
-#include <ModelAPI_AttributeRefList.h>
#include <ModelAPI_Data.h>
#include <ModelAPI_Document.h>
-#include <ModelAPI_Result.h>
-#include <boost/shared_ptr.hpp>
+#include <memory>
#include <list>
#include <string>
-class ModelAPI_Data;
-class ModelAPI_Document;
-class ModelAPI_Result;
-
/**\class ModelAPI_Feature
* \ingroup DataModel
* \brief Feature function that represents the particular functionality
class ModelAPI_Feature : public ModelAPI_Object
{
///< list of current results of this feature
- std::list<boost::shared_ptr<ModelAPI_Result> > myResults;
+ std::list<std::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()
+ inline static std::string group()
{
static std::string MY_GROUP = "Features";
return MY_GROUP;
}
/// Returns document this feature belongs to
- virtual boost::shared_ptr<ModelAPI_Document> document() const
+ virtual std::shared_ptr<ModelAPI_Document> document() const
{
return ModelAPI_Object::document();
}
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;
+ /// Computes the attribute value on the base of other attributes if the value can be computed
+ /// \param theAttributeId an attribute index to be computed
+ /// \return a boolean value about it is computed
+ virtual bool compute(const std::string& theAttributeId) { return false; };
+
+ /// Registers error during the execution, causes the ExecutionFailed state
+ virtual void setError(const std::string& theError) {
+ data()->setError(theError);
+ }
+
/// returns the current results of the feature
- MODELAPI_EXPORT const std::list<boost::shared_ptr<ModelAPI_Result> >& results();
+ MODELAPI_EXPORT const std::list<std::shared_ptr<ModelAPI_Result> >& results();
/// returns the first result in the list or NULL reference
- MODELAPI_EXPORT boost::shared_ptr<ModelAPI_Result> firstResult();
+ MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> firstResult();
+ /// returns the last result in the list or NULL reference
+ MODELAPI_EXPORT std::shared_ptr<ModelAPI_Result> lastResult();
/// sets the alone result
- MODELAPI_EXPORT void setResult(const boost::shared_ptr<ModelAPI_Result>& theResult);
+ MODELAPI_EXPORT void setResult(const std::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,
+ MODELAPI_EXPORT void setResult(const std::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);
+ MODELAPI_EXPORT void removeResult(const std::shared_ptr<ModelAPI_Result>& theResult);
+ /// removes all results starting from the gived index (zero-based)
+ MODELAPI_EXPORT void removeResults(const int theSinceIndex);
/// removes all results from the feature
MODELAPI_EXPORT void eraseResults();
/// removes all fields from this feature: results, data, etc
}
/// 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();
+ /// By default it is null document: it is added to the document this method is called to
+ MODELAPI_EXPORT virtual std::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);
+ /// Returns the feature by the object (result).
+ MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
//
// Helper methods, aliases for data()->method()
// -----------------------------------------------------------------------------------------------
+ /// Returns the name stored in the attribute
inline std::string name()
{
return data()->name();
}
-
- inline boost::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID)
+ /// Returns the Boolean attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeBoolean> boolean(const std::string& theID)
{
return data()->boolean(theID);
}
-
- inline boost::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID)
+ /// Returns the document reference attribute
+ inline std::shared_ptr<ModelAPI_AttributeDocRef> document(const std::string& theID)
{
return data()->document(theID);
}
-
- inline boost::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID)
+ /// Returns the real attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeDouble> real(const std::string& theID)
{
return data()->real(theID);
}
-
- inline boost::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID)
+ /// Returns the integer attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeInteger> integer(const std::string& theID)
{
return data()->integer(theID);
}
-
- inline boost::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
+ /// Returns the reference attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
{
return data()->refattr(theID);
}
-
- inline boost::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
+ /// Returns the reference attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeReference> reference(const std::string& theID)
{
return data()->reference(theID);
}
-
- inline boost::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID)
+ /// Returns the list of references attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeRefList> reflist(const std::string& theID)
{
return data()->reflist(theID);
}
-
- inline boost::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID)
+ /// Returns the shape selection attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeSelection> selection(const std::string& theID)
{
return data()->selection(theID);
}
-
- inline boost::shared_ptr<ModelAPI_AttributeSelectionList> selectionList(const std::string& theID)
+ /// Returns the list of shape selections attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeSelectionList> selectionList(const std::string& theID)
{
return data()->selectionList(theID);
}
-
- inline boost::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID)
+ /// Returns the string attribute by the identifier
+ inline std::shared_ptr<ModelAPI_AttributeString> string(const std::string& theID)
{
return data()->string(theID);
}
-
- inline boost::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
+ /// Returns the attribute by the identifier
+ inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
{
return data()->attribute(theID);
}
};
//! Pointer on feature object
-typedef boost::shared_ptr<ModelAPI_Feature> FeaturePtr;
+typedef std::shared_ptr<ModelAPI_Feature> FeaturePtr;
#endif
