SHAPER  9.12.0
ModelHighAPI_RefAttr.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 SRC_MODELHIGHAPI_MODELHIGHAPI_REFATTR_H_
21 #define SRC_MODELHIGHAPI_MODELHIGHAPI_REFATTR_H_
22 
23 //--------------------------------------------------------------------------------------
24 #include "ModelHighAPI.h"
25 
26 #include <memory>
27 #include <string>
28 //--------------------------------------------------------------------------------------
29 class ModelAPI_Attribute;
32 class ModelAPI_Object;
35 //--------------------------------------------------------------------------------------
41 {
42 public:
44  MODELHIGHAPI_EXPORT
47  MODELHIGHAPI_EXPORT
48  ModelHighAPI_RefAttr(const std::shared_ptr<ModelAPI_Attribute> & theValue);
50  MODELHIGHAPI_EXPORT
51  ModelHighAPI_RefAttr(const std::shared_ptr<ModelAPI_Object> & theValue);
53  MODELHIGHAPI_EXPORT
54  ModelHighAPI_RefAttr(const std::shared_ptr<ModelHighAPI_Interface> & theValue);
56  MODELHIGHAPI_EXPORT
57  virtual ~ModelHighAPI_RefAttr();
58 
60  MODELHIGHAPI_EXPORT virtual
61  void fillAttribute(const std::shared_ptr<ModelAPI_AttributeRefAttr> & theAttribute) const;
62 
64  MODELHIGHAPI_EXPORT virtual
65  void appendToList(const std::shared_ptr<ModelAPI_AttributeRefAttrList> & theAttribute) const;
66 
68  MODELHIGHAPI_EXPORT
69  bool isEmpty() const;
70 
72  MODELHIGHAPI_EXPORT
73  void fillMessage(const std::shared_ptr<ModelAPI_ObjectMovedMessage>& theMessage) const;
74 
75  std::shared_ptr<ModelAPI_Attribute> attr() const { return myAttribute; }
76  std::shared_ptr<ModelAPI_Object> object() const { return myObject; }
77 
78 private:
79  enum VariantType { VT_ATTRIBUTE, VT_OBJECT } myVariantType;
80  std::shared_ptr<ModelAPI_Attribute> myAttribute;
81  std::shared_ptr<ModelAPI_Object> myObject;
82 };
83 
84 //--------------------------------------------------------------------------------------
85 //--------------------------------------------------------------------------------------
86 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_REFATTR_H_ */
Attribute that contains list of references to features (located in the same document) or references t...
Definition: ModelAPI_AttributeRefAttrList.h:34
Attribute that contains reference to an attribute of a feature or reference to a feature (switchable)
Definition: ModelAPI_AttributeRefAttr.h:33
Generic attribute of the Object.
Definition: ModelAPI_Attribute.h:34
Message sent when feature or attribute has been moved.
Definition: ModelAPI_Events.h:603
Represents any object in the data model and in the object browser.
Definition: ModelAPI_Object.h:45
Base class for feature interfaces.
Definition: ModelHighAPI_Interface.h:42
Class for filling ModelAPI_AttributeRefAttr.
Definition: ModelHighAPI_RefAttr.h:41
ModelHighAPI_RefAttr()
Default constructor.
Definition: ModelHighAPI_RefAttr.cpp:29
bool isEmpty() const
Check the object is empty.
Definition: ModelHighAPI_RefAttr.cpp:80
void fillMessage(const std::shared_ptr< ModelAPI_ObjectMovedMessage > &theMessage) const
Fill moved message by the attribute or object.
Definition: ModelHighAPI_RefAttr.cpp:86
virtual ~ModelHighAPI_RefAttr()
Destructor.
Definition: ModelHighAPI_RefAttr.cpp:55
virtual void appendToList(const std::shared_ptr< ModelAPI_AttributeRefAttrList > &theAttribute) const
Append to list attribute.
Definition: ModelHighAPI_RefAttr.cpp:70
virtual void fillAttribute(const std::shared_ptr< ModelAPI_AttributeRefAttr > &theAttribute) const
Fill attribute values.
Definition: ModelHighAPI_RefAttr.cpp:60