X-Git-Url: http://git.salome-platform.org/gitweb/?a=blobdiff_plain;f=src%2FModelAPI%2FModelAPI_Attribute.h;h=9ee118984552e771d9cb5bb23d25dbf1b55d8e6f;hb=06e7f5859095193fc7f498bd89a7d28009794f53;hp=c54b395561b908739737abb7ba47674b92e11f43;hpb=85a3a34f6b8a9e925f4055e874c1e7f8833f0ac3;p=modules%2Fshaper.git diff --git a/src/ModelAPI/ModelAPI_Attribute.h b/src/ModelAPI/ModelAPI_Attribute.h index c54b39556..9ee118984 100644 --- a/src/ModelAPI/ModelAPI_Attribute.h +++ b/src/ModelAPI/ModelAPI_Attribute.h @@ -1,13 +1,28 @@ -// File: ModelAPI_Attribute.h -// Created: 2 Apr 2014 -// Author: Mikhail PONIKAROV +// Copyright (C) 2014-2023 CEA, EDF +// +// This library is free software; you can redistribute it and/or +// modify it under the terms of the GNU Lesser General Public +// License as published by the Free Software Foundation; either +// version 2.1 of the License, or (at your option) any later version. +// +// This library is distributed in the hope that it will be useful, +// but WITHOUT ANY WARRANTY; without even the implied warranty of +// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU +// Lesser General Public License for more details. +// +// You should have received a copy of the GNU Lesser General Public +// License along with this library; if not, write to the Free Software +// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +// +// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com +// #ifndef ModelAPI_Attribute_H_ #define ModelAPI_Attribute_H_ #include "ModelAPI.h" #include -#include +#include class ModelAPI_Object; @@ -18,69 +33,77 @@ class ModelAPI_Object; class ModelAPI_Attribute { ///< needed here to emit signal that feature changed on change of the attribute - boost::shared_ptr myObject; + std::shared_ptr myObject; + std::string myID; ///< identifier of this attribute in Data class protected: // accessible from the attributes - bool myIsInitialized; - bool myIsArgument; + bool myIsInitialized; ///< is some value assigned to this attribute + bool mySetInitializedBlocked; ///< is initialized blocked + bool myIsArgument; ///< is this attribute used as an argument for execution + bool myIsImmutable; ///< is this attribute can be changed programmatically (e.g. by constraint) + public: /// Returns the type of this class of attributes, not static method MODELAPI_EXPORT virtual std::string attributeType() = 0; /// To virtually destroy the fields of successors - MODELAPI_EXPORT virtual ~ModelAPI_Attribute() - { - } + MODELAPI_EXPORT virtual ~ModelAPI_Attribute(); /// Sets the owner of this attribute - MODELAPI_EXPORT virtual void setObject(const boost::shared_ptr& theObject) - { - myObject = theObject; - } + MODELAPI_EXPORT virtual void setObject(const std::shared_ptr& theObject); /// Returns the owner of this attribute - MODELAPI_EXPORT const boost::shared_ptr& owner() const - { - return myObject; - } + MODELAPI_EXPORT const std::shared_ptr& owner() const; /// Returns true if attribute was initialized by some value - MODELAPI_EXPORT bool isInitialized() - { - return myIsInitialized; - } + MODELAPI_EXPORT virtual bool isInitialized(); /// Makes attribute initialized - MODELAPI_EXPORT void setInitialized() - { - myIsInitialized = true; - } + MODELAPI_EXPORT void setInitialized(); + + /// Blocks sending "attribute updated" if theBlock is true + /// \param theBlock a block value + /// \return the previous block value + MODELAPI_EXPORT bool blockSetInitialized(const bool theBlock); - /// Set this attribute is argument for result (change of this attribute requires update of result). + /// Set this attribute is argument for result + /// (change of this attribute requires update of result). /// By default it is true. - MODELAPI_EXPORT void setIsArgument(const bool theFlag) - { - myIsArgument = theFlag; - } + MODELAPI_EXPORT void setIsArgument(const bool theFlag); /// Returns true if attribute causes the result change - MODELAPI_EXPORT bool isArgument() - { - return myIsArgument; - } + MODELAPI_EXPORT bool isArgument(); + + /// Immutable argument can not be changed programmatically (e.g. by constraint) + /// By default it is false. + /// Returns the previous state of the attribute's immutability. + MODELAPI_EXPORT bool setImmutable(const bool theFlag); + + /// Returns true if can not be changed programmatically + MODELAPI_EXPORT bool isImmutable(); + + /// ID of the attribute in Data + MODELAPI_EXPORT const std::string& id() const; + + /// Resets attribute to deafult state. + MODELAPI_EXPORT virtual void reset(); protected: /// Objects are created for features automatically - ModelAPI_Attribute() - { - myIsInitialized = false; - myIsArgument = true; - } + MODELAPI_EXPORT ModelAPI_Attribute(); + + /// Sets the ID of the attribute in Data (called from Data) + MODELAPI_EXPORT virtual void setID(const std::string theID); + + /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc) + MODELAPI_EXPORT virtual void reinit(); + friend class Model_Data; + friend class Model_Objects; }; //! Pointer on attribute object -typedef boost::shared_ptr AttributePtr; +typedef std::shared_ptr AttributePtr; #endif