src/Model/Model_AttributeRefAttr.h

   1 // Copyright (C) 2014-2023  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_AttributeRefAttr_H_
  21 #define Model_AttributeRefAttr_H_
  22
  23 #include "Model.h"
  24 #include "ModelAPI_AttributeRefAttr.h"
  25 #include <TDF_Label.hxx>
  26 #include <TDF_Reference.hxx>
  27 #include <TDataStd_Comment.hxx>
  28
  29 /**\class Model_AttributeRefAttr
  30  * \ingroup DataModel
  31  * \brief Attribute that contains reference to an attribute of a feature
  32  * (located in the same document).
  33  */
  34
  35 class Model_AttributeRefAttr : public ModelAPI_AttributeRefAttr
  36 {
  37   Handle_TDF_Reference myRef;  ///< reference to the feature label
  38   TDF_Label myLab; ///< the main label of this attribute
  39   ///< ID of the referenced attribute (empty if this is a reference to a feature)
  40   Handle_TDataStd_Comment myID;
  41  public:
  42   /// Returns true if this attribute references to a object (not to the attribute)
  43   MODEL_EXPORT virtual bool isObject();
  44
  45   /// Defines the reference to the attribute
  46   MODEL_EXPORT virtual void setAttr(std::shared_ptr<ModelAPI_Attribute> theAttr);
  47
  48   /// Returns attribute referenced from this attribute
  49   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Attribute> attr();
  50
  51   /// Defines the reference to the object
  52   MODEL_EXPORT virtual void setObject(ObjectPtr theFeature);
  53
  54   /// Returns object referenced from this attribute
  55   MODEL_EXPORT virtual ObjectPtr object();
  56
  57   /// Returns true if attribute was  initialized by some value
  58   MODEL_EXPORT virtual bool isInitialized();
  59
  60  protected:
  61   /// Objects are created for features automatically
  62   MODEL_EXPORT Model_AttributeRefAttr(TDF_Label& theLabel);
  63   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
  64   virtual void reinit();
  65
  66   friend class Model_Data;
  67 };
  68
  69 #endif