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