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