src/ModelAPI/ModelAPI_AttributeDocRef.h

   1 // Copyright (C) 2014-2017  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
  18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
  19 //
  20
  21 #ifndef ModelAPI_AttributeDocRef_H_
  22 #define ModelAPI_AttributeDocRef_H_
  23
  24 #include "ModelAPI_Attribute.h"
  25 #include "ModelAPI_Document.h"
  26
  27 /**\class ModelAPI_AttributeDocRef
  28  * \ingroup DataModel
  29  * \brief Attribute that contains reference to another document.
  30  */
  31
  32 class ModelAPI_AttributeDocRef : public ModelAPI_Attribute
  33 {
  34  public:
  35   /// Defines the document referenced from this attribute
  36   MODELAPI_EXPORT virtual void setValue(std::shared_ptr<ModelAPI_Document> theDoc) = 0;
  37
  38   /// Returns document referenced from this attribute
  39   MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> value() = 0;
  40
  41   /// Returns the persistent ID of the document
  42   MODELAPI_EXPORT virtual int docId() = 0;
  43
  44   /// Returns the type of this class of attributes
  45   MODELAPI_EXPORT static std::string typeId()
  46   {
  47     return "DocRef";
  48   }
  49
  50   /// Returns the type of this class of attributes, not static method
  51   MODELAPI_EXPORT virtual std::string attributeType();
  52
  53   /// To virtually destroy the fields of successors
  54   MODELAPI_EXPORT virtual ~ModelAPI_AttributeDocRef();
  55
  56  protected:
  57   /// Objects are created for features automatically
  58   MODELAPI_EXPORT ModelAPI_AttributeDocRef();
  59 };
  60
  61 typedef std::shared_ptr<ModelAPI_AttributeDocRef> AttributeDocRefPtr;
  62
  63 #endif