src/Model/Model_AttributeStringArray.h

   1 // Copyright (C) 2014-2020  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 Model_AttributeStringArray_H_
  21 #define Model_AttributeStringArray_H_
  22
  23 #include <Model.h>
  24 #include <ModelAPI_AttributeStringArray.h>
  25 #include <TDataStd_ExtStringArray.hxx>
  26 #include <TDF_Label.hxx>
  27
  28 /// \class Model_AttributeStringArray
  29 /// \ingroup DataModel
  30 /// \brief API for the attribute that contains several strings in the array inside.
  31 class Model_AttributeStringArray: public ModelAPI_AttributeStringArray
  32 {
  33 public:
  34   /// Returns the size of the array (zero means that it is empty)
  35   MODEL_EXPORT virtual int size();
  36
  37   /// Sets the new size of the array. The previous data is erased.
  38   MODEL_EXPORT virtual void setSize(const int theSize);
  39
  40   /// Defines the value of the array by index [0; size-1]
  41   MODEL_EXPORT virtual void setValue(const int theIndex,
  42                                      const std::string theValue);
  43
  44   /// Returns the value by the index
  45   MODEL_EXPORT virtual std::string value(const int theIndex);
  46
  47 protected:
  48   /// Objects are created for features automatically
  49   MODEL_EXPORT Model_AttributeStringArray(TDF_Label& theLabel);
  50
  51 private:
  52   /// The OCCT array that keeps all values.
  53   Handle_TDataStd_ExtStringArray myArray;
  54
  55   /// Stores the label as a field to set array if size is not null (null array is buggy in OCAF)
  56   TDF_Label myLab;
  57
  58   friend class Model_Data;
  59 };
  60
  61 #endif