src/ModelHighAPI/ModelHighAPI_RefAttr.h

   1 // Copyright (C) 2014-2023  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 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;
  30 class ModelAPI_AttributeRefAttr;
  31 class ModelAPI_AttributeRefAttrList;
  32 class ModelAPI_Object;
  33 class ModelAPI_ObjectMovedMessage;
  34 class ModelHighAPI_Interface;
  35 //--------------------------------------------------------------------------------------
  36 /**\class ModelHighAPI_RefAttr
  37  * \ingroup CPPHighAPI
  38  * \brief Class for filling ModelAPI_AttributeRefAttr
  39  */
  40 class ModelHighAPI_RefAttr
  41 {
  42 public:
  43   /// Default constructor
  44   MODELHIGHAPI_EXPORT
  45   ModelHighAPI_RefAttr();
  46   /// Constructor for attribute
  47   MODELHIGHAPI_EXPORT
  48   ModelHighAPI_RefAttr(const std::shared_ptr<ModelAPI_Attribute> & theValue);
  49   /// Constructor for object
  50   MODELHIGHAPI_EXPORT
  51   ModelHighAPI_RefAttr(const std::shared_ptr<ModelAPI_Object> & theValue);
  52   /// Constructor for Interface (use result() for object)
  53   MODELHIGHAPI_EXPORT
  54   ModelHighAPI_RefAttr(const std::shared_ptr<ModelHighAPI_Interface> & theValue);
  55   /// Destructor
  56   MODELHIGHAPI_EXPORT
  57   virtual ~ModelHighAPI_RefAttr();
  58
  59   /// Fill attribute values
  60   MODELHIGHAPI_EXPORT virtual
  61     void fillAttribute(const std::shared_ptr<ModelAPI_AttributeRefAttr> & theAttribute) const;
  62
  63   /// Append to list attribute
  64   MODELHIGHAPI_EXPORT virtual
  65     void appendToList(const std::shared_ptr<ModelAPI_AttributeRefAttrList> & theAttribute) const;
  66
  67   /// Check the object is empty
  68   MODELHIGHAPI_EXPORT
  69   bool isEmpty() const;
  70
  71   /// Fill moved message by the attribute or object
  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_ */