src/Model/Model_AttributeReference.h

   1 // Copyright (C) 2014-2024  CEA, EDF
   2 //
   3 // This library is free software; you can redistribute it and/or
   4 // modify it under the terms of the GNU Lesser General Public
   5 // License as published by the Free Software Foundation; either
   6 // version 2.1 of the License, or (at your option) any later version.
   7 //
   8 // This library is distributed in the hope that it will be useful,
   9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11 // Lesser General Public License for more details.
  12 //
  13 // You should have received a copy of the GNU Lesser General Public
  14 // License along with this library; if not, write to the Free Software
  15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef Model_AttributeReference_H_
  21 #define Model_AttributeReference_H_
  22
  23 #include "Model.h"
  24 #include "ModelAPI_AttributeReference.h"
  25 #include <ModelAPI_Feature.h>
  26 #include <TDF_Label.hxx>
  27 #include <TDF_Reference.hxx>
  28
  29 /**\class Model_AttributeReference
  30  * \ingroup DataModel
  31  * \brief Attribute that contains reference to feature (located in the same document).
  32  */
  33
  34 class Model_AttributeReference : public ModelAPI_AttributeReference
  35 {
  36   TDF_Label myLab; ///< the main label of this attribute
  37   Handle_TDF_Reference myRef;  ///< references to the feature label
  38  public:
  39   /// Defines the object referenced from this attribute
  40   MODEL_EXPORT virtual void setValue(ObjectPtr theObject);
  41
  42   /// Returns object referenced from this attribute
  43   MODEL_EXPORT virtual ObjectPtr value();
  44
  45   MODEL_EXPORT ~Model_AttributeReference();
  46
  47   MODEL_EXPORT virtual void setObject(const std::shared_ptr<ModelAPI_Object>& theObject);
  48
  49   /// Returns true if attribute was  initialized by some value
  50   MODEL_EXPORT virtual bool isInitialized();
  51
  52
  53 protected:
  54   /// Objects are created for features automatically
  55   MODEL_EXPORT Model_AttributeReference(TDF_Label& theLabel);
  56   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
  57   virtual void reinit();
  58
  59   friend class Model_Data;
  60   friend class Model_AttributeSelection;
  61 };
  62
  63 #endif