X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;ds=inline;f=src%2FModelAPI%2FModelAPI_Feature.h;h=452686cdb20906749a9c312f2a720c0a32121adc;hb=38afbd899a8645c83e17f2c24a17a2b7414911b4;hp=ef1212afc7156b1f32412d5315fe2ed080f330e3;hpb=83770c7e51b6fb551ef233ef19f6099a68ca55f6;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Feature.h b/src/ModelAPI/ModelAPI_Feature.h index ef1212afc..452686cdb 100644 --- a/src/ModelAPI/ModelAPI_Feature.h +++ b/src/ModelAPI/ModelAPI_Feature.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_Feature.hxx // Created: 21 Mar 2014 // Author: Mikhail PONIKAROV @@ -5,16 +7,15 @@ #ifndef ModelAPI_Feature_H_ #define ModelAPI_Feature_H_ -#include "ModelAPI_Object.h" -#include "ModelAPI_PluginManager.h" +#include +#include +#include +#include -#include -#include -#include +#include -class ModelAPI_Data; -class ModelAPI_Document; -class ModelAPI_Result; +#include +#include /**\class ModelAPI_Feature * \ingroup DataModel @@ -24,7 +25,7 @@ class ModelAPI_Result; class ModelAPI_Feature : public ModelAPI_Object { ///< list of current results of this feature - std::list > myResults; + std::list > myResults; public: /// Returns the unique kind of a feature (like "Point") virtual const std::string& getKind() = 0; @@ -36,6 +37,12 @@ class ModelAPI_Feature : public ModelAPI_Object return MY_GROUP; } + /// Returns document this feature belongs to + virtual std::shared_ptr document() const + { + return ModelAPI_Object::document(); + } + /// Returns the group identifier of this result virtual std::string groupName() { @@ -48,19 +55,28 @@ class ModelAPI_Feature : public ModelAPI_Object /// Computes or recomputes the results virtual void execute() = 0; + /// 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 >& results(); + MODELAPI_EXPORT const std::list >& results(); /// returns the first result in the list or NULL reference - MODELAPI_EXPORT boost::shared_ptr firstResult(); + MODELAPI_EXPORT std::shared_ptr firstResult(); + /// returns the last result in the list or NULL reference + MODELAPI_EXPORT std::shared_ptr lastResult(); /// sets the alone result - MODELAPI_EXPORT void setResult(const boost::shared_ptr& theResult); + MODELAPI_EXPORT void setResult(const std::shared_ptr& theResult); /// sets the result by index (zero based), results before this must be set before - MODELAPI_EXPORT void setResult(const boost::shared_ptr& theResult, + MODELAPI_EXPORT void setResult(const std::shared_ptr& theResult, const int theIndex); /// removes the result from the feature - MODELAPI_EXPORT void removeResult(const boost::shared_ptr& theResult); + MODELAPI_EXPORT void removeResult(const std::shared_ptr& 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. @@ -75,16 +91,80 @@ class ModelAPI_Feature : public ModelAPI_Object /// Must return document where the new feature must be added to /// By default it is current document - MODELAPI_EXPORT virtual boost::shared_ptr documentToAdd(); + MODELAPI_EXPORT virtual std::shared_ptr documentToAdd(); /// To virtually destroy the fields of successors MODELAPI_EXPORT virtual ~ModelAPI_Feature(); - MODELAPI_EXPORT static boost::shared_ptr feature(ObjectPtr theObject); + MODELAPI_EXPORT static std::shared_ptr feature(ObjectPtr theObject); + + // + // Helper methods, aliases for data()->method() + // ----------------------------------------------------------------------------------------------- + inline std::string name() + { + return data()->name(); + } + + inline std::shared_ptr boolean(const std::string& theID) + { + return data()->boolean(theID); + } + + inline std::shared_ptr document(const std::string& theID) + { + return data()->document(theID); + } + + inline std::shared_ptr real(const std::string& theID) + { + return data()->real(theID); + } + + inline std::shared_ptr integer(const std::string& theID) + { + return data()->integer(theID); + } + + inline std::shared_ptr refattr(const std::string& theID) + { + return data()->refattr(theID); + } + + inline std::shared_ptr reference(const std::string& theID) + { + return data()->reference(theID); + } + + inline std::shared_ptr reflist(const std::string& theID) + { + return data()->reflist(theID); + } + inline std::shared_ptr selection(const std::string& theID) + { + return data()->selection(theID); + } + + inline std::shared_ptr selectionList(const std::string& theID) + { + return data()->selectionList(theID); + } + + inline std::shared_ptr string(const std::string& theID) + { + return data()->string(theID); + } + + inline std::shared_ptr attribute(const std::string& theID) + { + return data()->attribute(theID); + } + // ----------------------------------------------------------------------------------------------- }; //! Pointer on feature object -typedef boost::shared_ptr FeaturePtr; +typedef std::shared_ptr FeaturePtr; #endif +