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