src/Model/Model_AttributeIntArray.h

   1 // Copyright (C) 2014-2023  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_ATTRIBUTEINTARRAY_H_
  21 #define MODEL_ATTRIBUTEINTARRAY_H_
  22
  23 #include <Model.h>
  24 #include <ModelAPI_AttributeIntArray.h>
  25
  26 #include <TDF_Label.hxx>
  27 #include <TDataStd_IntegerArray.hxx>
  28
  29 #include <string>
  30
  31 /**\class Model_AttributeIntArray
  32  * \ingroup DataModel
  33  * \brief API for the attribute that contains several integers in the array inside.
  34  * Used for RGB color storage for an example. By default size is one, zero-based.
  35  * Represented as array in OCCT. Empty array means that this attribute does not exists.
  36  */
  37
  38 class Model_AttributeIntArray : public ModelAPI_AttributeIntArray
  39 {
  40   /// The OCCT array that keeps all values.
  41   Handle_TDataStd_IntegerArray myArray;
  42   /// Stores the label as a field to set array if size is not null (null array is buggy in OCAF)
  43   TDF_Label myLab;
  44  public:
  45
  46   /// Returns the size of the array (zero means that it is empty)
  47   MODEL_EXPORT virtual int size();
  48
  49   /// Sets the new size of the array. The previous data is erased.
  50   MODEL_EXPORT virtual void setSize(const int theSize,
  51                                     bool sendUpdated = true);
  52
  53   /// Defines the value of the array by index [0; size-1]
  54   MODEL_EXPORT virtual void setValue(const int theIndex,
  55                                      const int theValue,
  56                                      bool sendUpdated = true);
  57
  58   /// Returns the value by the index
  59   MODEL_EXPORT virtual int value(const int theIndex);
  60
  61
  62  protected:
  63   /// Initializes attibutes
  64   Model_AttributeIntArray(TDF_Label& theLabel);
  65   /// Reinitializes the internal state of the attribute (may be needed on undo/redo, abort, etc)
  66   virtual void reinit();
  67
  68   friend class Model_Data;
  69 };
  70
  71 #endif