src/ModelAPI/ModelAPI_AttributeBoolean.h

   1 // Copyright (C) 2014-2023  CEA, EDF
   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_ATTRIBUTEBOOLEAN_H_
  21 #define MODELAPI_ATTRIBUTEBOOLEAN_H_
  22
  23 #include "ModelAPI_Attribute.h"
  24
  25 /**\class ModelAPI_AttributeBoolean
  26  * \ingroup DataModel
  27  * \brief Attribute that contains boolean value.
  28  */
  29
  30 class ModelAPI_AttributeBoolean : public ModelAPI_Attribute
  31 {
  32  public:
  33   /// Defines the double value
  34   MODELAPI_EXPORT virtual void setValue(bool theValue) = 0;
  35
  36   /// Returns the double value
  37   MODELAPI_EXPORT virtual bool value() = 0;
  38
  39   /// Returns the type of this class of attributes
  40   MODELAPI_EXPORT static std::string typeId()
  41   {
  42     return "Boolean";
  43   }
  44
  45   /// Returns the type of this class of attributes, not static method
  46   MODELAPI_EXPORT virtual std::string attributeType();
  47
  48   /// To virtually destroy the fields of successors
  49   MODELAPI_EXPORT virtual ~ModelAPI_AttributeBoolean();
  50
  51  protected:
  52   /// Objects are created for features automatically
  53   MODELAPI_EXPORT ModelAPI_AttributeBoolean();
  54 };
  55
  56 typedef std::shared_ptr<ModelAPI_AttributeBoolean> AttributeBooleanPtr;
  57
  58 #endif