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 email : webmaster.salome@opencascade.com<mailto: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 ModelHighAPI_Interface;
  34 //--------------------------------------------------------------------------------------
  35 /**\class ModelHighAPI_RefAttr
  36  * \ingroup CPPHighAPI
  37  * \brief Class for filling ModelAPI_AttributeRefAttr
  38  */
  39 class ModelHighAPI_RefAttr
  40 {
  41 public:
  42   /// Default constructor
  43   MODELHIGHAPI_EXPORT
  44   ModelHighAPI_RefAttr();
  45   /// Constructor for attribute
  46   MODELHIGHAPI_EXPORT
  47   ModelHighAPI_RefAttr(const std::shared_ptr<ModelAPI_Attribute> & theValue);
  48   /// Constructor for object
  49   MODELHIGHAPI_EXPORT
  50   ModelHighAPI_RefAttr(const std::shared_ptr<ModelAPI_Object> & theValue);
  51   /// Constructor for Interface (use result() for object)
  52   MODELHIGHAPI_EXPORT
  53   ModelHighAPI_RefAttr(const std::shared_ptr<ModelHighAPI_Interface> & theValue);
  54   /// Destructor
  55   MODELHIGHAPI_EXPORT
  56   virtual ~ModelHighAPI_RefAttr();
  57
  58   /// Fill attribute values
  59   MODELHIGHAPI_EXPORT virtual
  60     void fillAttribute(const std::shared_ptr<ModelAPI_AttributeRefAttr> & theAttribute) const;
  61
  62   /// Append to list attribute
  63   MODELHIGHAPI_EXPORT virtual
  64     void appendToList(const std::shared_ptr<ModelAPI_AttributeRefAttrList> & theAttribute) const;
  65
  66   /// Check the object is empty
  67   MODELHIGHAPI_EXPORT
  68   bool isEmpty() const;
  69
  70 private:
  71   enum VariantType { VT_ATTRIBUTE, VT_OBJECT } myVariantType;
  72   std::shared_ptr<ModelAPI_Attribute> myAttribute;
  73   std::shared_ptr<ModelAPI_Object> myObject;
  74 };
  75
  76 //--------------------------------------------------------------------------------------
  77 //--------------------------------------------------------------------------------------
  78 #endif /* SRC_MODELHIGHAPI_MODELHIGHAPI_REFATTR_H_ */