src/ModelAPI/ModelAPI_AttributeRefAttr.h

   1 // Copyright (C) 2014-2022  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 ModelAPI_AttributeRefAttr_H_
  21 #define ModelAPI_AttributeRefAttr_H_
  22
  23 #include "ModelAPI_Attribute.h"
  24 #include "ModelAPI_Feature.h"
  25
  26 /**\class ModelAPI_AttributeRefAttr
  27  * \ingroup DataModel
  28  * \brief Attribute that contains reference to an attribute of a feature or reference to
  29  * a feature (switchable)
  30  */
  31
  32 class ModelAPI_AttributeRefAttr : public ModelAPI_Attribute
  33 {
  34  public:
  35   /// Returns true if this attribute references to a object (not to the attribute)
  36   MODELAPI_EXPORT virtual bool isObject() = 0;
  37
  38   /// Defines the reference to the attribute
  39   MODELAPI_EXPORT virtual void setAttr(AttributePtr theAttr) = 0;
  40
  41   /// Returns attribute referenced from this attribute
  42   MODELAPI_EXPORT virtual AttributePtr attr() = 0;
  43
  44   /// Defines the reference to the object
  45   MODELAPI_EXPORT virtual void setObject(ObjectPtr theFeature) = 0;
  46
  47   /// Returns object referenced from this attribute
  48   MODELAPI_EXPORT virtual ObjectPtr object() = 0;
  49
  50   /// Returns the type of this class of attributes
  51   MODELAPI_EXPORT static std::string typeId()
  52   {
  53     return "RefAttr";
  54   }
  55
  56   /// Returns the type of this class of attributes, not static method
  57   MODELAPI_EXPORT virtual std::string attributeType();
  58
  59   /// To virtually destroy the fields of successors
  60   MODELAPI_EXPORT virtual ~ModelAPI_AttributeRefAttr();
  61
  62  protected:
  63   /// Objects are created for features automatically
  64   MODELAPI_EXPORT ModelAPI_AttributeRefAttr();
  65 };
  66
  67 typedef std::shared_ptr<ModelAPI_AttributeRefAttr> AttributeRefAttrPtr;
  68
  69 #endif