SHAPER  9.12.0
ModelAPI_AttributeDocRef.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 ModelAPI_AttributeDocRef_H_
21 #define ModelAPI_AttributeDocRef_H_
22 
23 #include "ModelAPI_Attribute.h"
24 #include "ModelAPI_Document.h"
25 
32 {
33  public:
35  MODELAPI_EXPORT virtual void setValue(std::shared_ptr<ModelAPI_Document> theDoc) = 0;
36 
38  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> value() = 0;
39 
41  MODELAPI_EXPORT virtual int docId() = 0;
42 
44  MODELAPI_EXPORT static std::string typeId()
45  {
46  return "DocRef";
47  }
48 
50  MODELAPI_EXPORT virtual std::string attributeType();
51 
53  MODELAPI_EXPORT virtual ~ModelAPI_AttributeDocRef();
54 
55  protected:
57  MODELAPI_EXPORT ModelAPI_AttributeDocRef();
58 };
59 
60 typedef std::shared_ptr<ModelAPI_AttributeDocRef> AttributeDocRefPtr;
61 
62 #endif
Attribute that contains reference to another document.
Definition: ModelAPI_AttributeDocRef.h:32
virtual std::shared_ptr< ModelAPI_Document > value()=0
Returns document referenced from this attribute.
virtual std::string attributeType()
Returns the type of this class of attributes, not static method.
Definition: ModelAPI_AttributeDocRef.cpp:22
virtual void setValue(std::shared_ptr< ModelAPI_Document > theDoc)=0
Defines the document referenced from this attribute.
static std::string typeId()
Returns the type of this class of attributes.
Definition: ModelAPI_AttributeDocRef.h:44
virtual int docId()=0
Returns the persistent ID of the document.
ModelAPI_AttributeDocRef()
Objects are created for features automatically.
Definition: ModelAPI_AttributeDocRef.cpp:31
virtual ~ModelAPI_AttributeDocRef()
To virtually destroy the fields of successors.
Definition: ModelAPI_AttributeDocRef.cpp:27
Generic attribute of the Object.
Definition: ModelAPI_Attribute.h:34