src/ModelAPI/ModelAPI_AttributeStringArray.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_AttributeStringArray_H_
  22 #define ModelAPI_AttributeStringArray_H_
  23
  24 #include <ModelAPI.h>
  25 #include <ModelAPI_Attribute.h>
  26
  27 #include <string>
  28
  29 /// \class ModelAPI_AttributeStringArray
  30 /// \ingroup DataModel
  31 /// \brief API for the attribute that contains several strings in the array inside.
  32 class ModelAPI_AttributeStringArray: public ModelAPI_Attribute
  33 {
  34 public:
  35   /// Returns the size of the array (zero means that it is empty)
  36   MODELAPI_EXPORT virtual int size() = 0;
  37
  38   /// Sets the new size of the array. The previous data is erased.
  39   MODELAPI_EXPORT virtual void setSize(const int theSize) = 0;
  40
  41   /// Defines the value of the array by index [0; size-1]
  42   MODELAPI_EXPORT virtual void setValue(const int theIndex,
  43                                         const std::string theValue) = 0;
  44
  45   /// Returns the value by the index
  46   MODELAPI_EXPORT virtual std::string value(const int theIndex) = 0;
  47
  48   /// Returns the type of this class of attributes
  49   MODELAPI_EXPORT static std::string typeId()
  50   {
  51     return "StringArray";
  52   }
  53
  54   /// Returns the type of this class of attributes, not static method
  55   MODELAPI_EXPORT virtual std::string attributeType();
  56
  57   /// To virtually destroy the fields of successors
  58   MODELAPI_EXPORT virtual ~ModelAPI_AttributeStringArray();
  59
  60 protected:
  61   /// Objects are created for features automatically
  62   MODELAPI_EXPORT ModelAPI_AttributeStringArray();
  63 };
  64
  65 /// Pointer on string attribute
  66 typedef std::shared_ptr<ModelAPI_AttributeStringArray> AttributeStringArrayPtr;
  67
  68 #endif