X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_AttributeSelection.h;h=61b1979a0b2c1643f126059a716fe8b556948649;hb=4587841469935cb1a28754558dece0ee77aa20a6;hp=9b4970c124a01e80f7ef4187e683c8f0a8e67971;hpb=93310e00f0ac95395137c842108790bf62e6425e;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_AttributeSelection.h b/src/ModelAPI/ModelAPI_AttributeSelection.h index 9b4970c12..61b1979a0 100644 --- a/src/ModelAPI/ModelAPI_AttributeSelection.h +++ b/src/ModelAPI/ModelAPI_AttributeSelection.h @@ -1,3 +1,5 @@ +// Copyright (C) 2014-20xx CEA/DEN, EDF R&D + // File: ModelAPI_AttributeSelection.h // Created: 2 Oct 2014 // Author: Mikhail PONIKAROV @@ -6,7 +8,7 @@ #define ModelAPI_AttributeSelection_H_ #include "ModelAPI_Attribute.h" -#include +#include /**\class ModelAPI_AttributeSelection * \ingroup DataModel @@ -17,37 +19,56 @@ class ModelAPI_AttributeSelection : public ModelAPI_Attribute { public: /// Defines the result and its selected sub-shape + /// \param theContext object where the sub-shape was selected + /// \param theSubShape selected sub-shape (if null, the whole context is selected) + /// \param theTemporarily if it is true, do not store and name the added in the data framework + /// (used to remove immideately, without the following updates) virtual void setValue( - const ResultBodyPtr& theContext, const boost::shared_ptr& theSubShape) = 0; + const ResultPtr& theContext, const std::shared_ptr& theSubShape, + const bool theTemporarily = false) = 0; /// Returns the selected subshape - virtual boost::shared_ptr value() = 0; + virtual std::shared_ptr value() = 0; /// Returns the context of the selection (the whole shape owner) - virtual ResultBodyPtr context() = 0; + virtual ResultPtr context() = 0; + + /// Updates the underlied selection due to the changes in the referenced objects + /// \returns false if update is failed + virtual bool update() = 0; /// Returns the type of this class of attributes - static std::string type() + static std::string typeId() { return "Selection"; } /// Returns the type of this class of attributes, not static method - virtual std::string attributeType() - { - return type(); - } + MODELAPI_EXPORT virtual std::string attributeType(); + + /// Returns a textual string of the selection + /// \param theDefaultValue a value, which is used if the naming name can not be obtained + virtual std::string namingName(const std::string& theDefaultValue = "") = 0; + + /// Returns an id of the selection + virtual int Id() = 0; + + + /// Selects sub-shape by the textual Name + virtual void selectSubShape(const std::string& theType, const std::string& theSubShapeName) = 0; + + /// Returns true if recompute of selection become impossible + virtual bool isInvalid() = 0; /// To virtually destroy the fields of successors - virtual ~ModelAPI_AttributeSelection() - { - } + MODELAPI_EXPORT virtual ~ModelAPI_AttributeSelection(); protected: /// Objects are created for features automatically - MODELAPI_EXPORT ModelAPI_AttributeSelection() - { - } + MODELAPI_EXPORT ModelAPI_AttributeSelection(); }; +//! Pointer on double attribute +typedef std::shared_ptr AttributeSelectionPtr; + #endif