]> SALOME platform Git repositories - modules/shaper.git/blob - src/ModelHighAPI/ModelHighAPI_Reference.h
Salome HOME
Issue #2358: Preserve state of folders on move in/out objects to a folder
[modules/shaper.git] / src / ModelHighAPI / ModelHighAPI_Reference.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 SRC_MODELHIGHAPI_MODELHIGHAPI_REFERENCE_H_
22 #define SRC_MODELHIGHAPI_MODELHIGHAPI_REFERENCE_H_
23
24 //--------------------------------------------------------------------------------------
25 #include "ModelHighAPI.h"
26
27 #include <memory>
28 #include <string>
29 //--------------------------------------------------------------------------------------
30 class ModelAPI_Attribute;
31 class ModelAPI_AttributeReference;
32 class ModelAPI_AttributeRefList;
33 class ModelAPI_Feature;
34 class ModelAPI_Object;
35 class ModelHighAPI_Interface;
36 //--------------------------------------------------------------------------------------
37 /**\class ModelHighAPI_Reference
38  * \ingroup CPPHighAPI
39  * \brief Class for filling ModelAPI_AttributeReference
40  */
41 class ModelHighAPI_Reference
42 {
43 public:
44   /// Default constructor
45   MODELHIGHAPI_EXPORT
46   ModelHighAPI_Reference();
47   /// Constructor for object
48   MODELHIGHAPI_EXPORT
49   ModelHighAPI_Reference(const std::shared_ptr<ModelAPI_Object> & theValue);
50   /// Constructor for Interface (use result() for object)
51   MODELHIGHAPI_EXPORT
52   ModelHighAPI_Reference(const std::shared_ptr<ModelHighAPI_Interface> & theValue);
53   /// Destructor
54   MODELHIGHAPI_EXPORT
55   virtual ~ModelHighAPI_Reference();
56
57   /// Fill attribute values
58   MODELHIGHAPI_EXPORT virtual
59     void fillAttribute(const std::shared_ptr<ModelAPI_AttributeReference> & theAttribute) const;
60
61   /// Append to list attribute
62   MODELHIGHAPI_EXPORT
63   virtual void appendToList(const std::shared_ptr<ModelAPI_AttributeRefList> & theAttribute) const;
64
65   /// Returns feature for this object.
66   MODELHIGHAPI_EXPORT
67   virtual std::shared_ptr<ModelAPI_Feature> feature() const;
68
69 private:
70   std::shared_ptr<ModelAPI_Object> myObject;
71 };
72
73 //--------------------------------------------------------------------------------------
74 //--------------------------------------------------------------------------------------
75 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_REFATTR_H_ */