src/ModelAPI/ModelAPI_AttributeString.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_ATTRIBUTESTRING_H_
  21 #define MODELAPI_ATTRIBUTESTRING_H_
  22
  23 #include "ModelAPI_Attribute.h"
  24
  25 #include <string>
  26
  27 /**\class ModelAPI_AttributeString
  28  * \ingroup DataModel
  29  * \brief API for the attribute that contains std (null terminated) string.
  30  */
  31
  32 class ModelAPI_AttributeString : public ModelAPI_Attribute
  33 {
  34  public:
  35   /// Defines the string value
  36   MODELAPI_EXPORT virtual void setValue(const std::string& theValue) = 0;
  37   /// Defines the wstring value
  38   MODELAPI_EXPORT virtual void setValue(const std::wstring& theValue) = 0;
  39
  40   /// Returns the string value
  41   MODELAPI_EXPORT virtual std::string value() = 0;
  42   /// Returns a pointer to Unicode string
  43   MODELAPI_EXPORT virtual char16_t* valueU() = 0;
  44   MODELAPI_EXPORT virtual bool isUValue() const = 0;
  45
  46   /// Returns the type of this class of attributes
  47   MODELAPI_EXPORT static std::string typeId()
  48   {
  49     return "String";
  50   }
  51
  52   /// Returns the type of this class of attributes, not static method
  53   MODELAPI_EXPORT virtual std::string attributeType();
  54
  55   /// To virtually destroy the fields of successors
  56   MODELAPI_EXPORT virtual ~ModelAPI_AttributeString();
  57
  58  protected:
  59   /// Objects are created for features automatically
  60   MODELAPI_EXPORT ModelAPI_AttributeString();
  61 };
  62
  63 //! Pointer on string attribute
  64 typedef std::shared_ptr<ModelAPI_AttributeString> AttributeStringPtr;
  65
  66 #endif