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