src/ModelHighAPI/ModelHighAPI_RefAttr.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_REFATTR_H_
  22 #define SRC_MODELHIGHAPI_MODELHIGHAPI_REFATTR_H_
  23
  24 //--------------------------------------------------------------------------------------
  25 #include "ModelHighAPI.h"
  26
  27 #include <memory>
  28 #include <string>
  29 //--------------------------------------------------------------------------------------
  30 class ModelAPI_Attribute;
  31 class ModelAPI_AttributeRefAttr;
  32 class ModelAPI_AttributeRefAttrList;
  33 class ModelAPI_Object;
  34 class ModelAPI_ObjectMovedMessage;
  35 class ModelHighAPI_Interface;
  36 //--------------------------------------------------------------------------------------
  37 /**\class ModelHighAPI_RefAttr
  38  * \ingroup CPPHighAPI
  39  * \brief Class for filling ModelAPI_AttributeRefAttr
  40  */
  41 class ModelHighAPI_RefAttr
  42 {
  43 public:
  44   /// Default constructor
  45   MODELHIGHAPI_EXPORT
  46   ModelHighAPI_RefAttr();
  47   /// Constructor for attribute
  48   MODELHIGHAPI_EXPORT
  49   ModelHighAPI_RefAttr(const std::shared_ptr<ModelAPI_Attribute> & theValue);
  50   /// Constructor for object
  51   MODELHIGHAPI_EXPORT
  52   ModelHighAPI_RefAttr(const std::shared_ptr<ModelAPI_Object> & theValue);
  53   /// Constructor for Interface (use result() for object)
  54   MODELHIGHAPI_EXPORT
  55   ModelHighAPI_RefAttr(const std::shared_ptr<ModelHighAPI_Interface> & theValue);
  56   /// Destructor
  57   MODELHIGHAPI_EXPORT
  58   virtual ~ModelHighAPI_RefAttr();
  59
  60   /// Fill attribute values
  61   MODELHIGHAPI_EXPORT virtual
  62     void fillAttribute(const std::shared_ptr<ModelAPI_AttributeRefAttr> & theAttribute) const;
  63
  64   /// Append to list attribute
  65   MODELHIGHAPI_EXPORT virtual
  66     void appendToList(const std::shared_ptr<ModelAPI_AttributeRefAttrList> & theAttribute) const;
  67
  68   /// Check the object is empty
  69   MODELHIGHAPI_EXPORT
  70   bool isEmpty() const;
  71
  72   /// Fill moved message by the attribute or object
  73   MODELHIGHAPI_EXPORT
  74   void fillMessage(const std::shared_ptr<ModelAPI_ObjectMovedMessage>& theMessage) const;
  75
  76 private:
  77   enum VariantType { VT_ATTRIBUTE, VT_OBJECT } myVariantType;
  78   std::shared_ptr<ModelAPI_Attribute> myAttribute;
  79   std::shared_ptr<ModelAPI_Object> myObject;
  80 };
  81
  82 //--------------------------------------------------------------------------------------
  83 //--------------------------------------------------------------------------------------
  84 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_REFATTR_H_ */