src/Model/Model_AttributeDocRef.h

   1 // Copyright (C) 2014-2022  CEA/DEN, EDF R&D
   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_AttributeDocRef_H_
  21 #define Model_AttributeDocRef_H_
  22
  23 #include "Model.h"
  24 #include "ModelAPI_AttributeDocRef.h"
  25 #include <TDataStd_Integer.hxx>
  26 #include <TDF_Label.hxx>
  27
  28 /**\class Model_AttributeDocRef
  29  * \ingroup DataModel
  30  * \brief Attribute that contains reference to another document.
  31  */
  32
  33 class Model_AttributeDocRef : public ModelAPI_AttributeDocRef
  34 {
  35   /// persistent and unique identifier of the document in the application
  36   Handle(TDataStd_Integer) myID;
  37  public:
  38
  39   /// Defines the document referenced from this attribute
  40   MODEL_EXPORT virtual void setValue(std::shared_ptr<ModelAPI_Document> theDoc);
  41
  42   /// Returns document referenced from this attribute
  43   MODEL_EXPORT virtual std::shared_ptr<ModelAPI_Document> value();
  44
  45   /// Returns the persisten ID of the document
  46   MODEL_EXPORT virtual int docId();
  47
  48  protected:
  49   /// Initializes attibutes
  50   Model_AttributeDocRef(TDF_Label& theLabel);
  51
  52   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
  53   virtual void reinit();
  54
  55   friend class Model_Data;
  56 };
  57
  58 #endif