]> SALOME platform Git repositories - modules/kernel.git/blob - src/SALOMEDSImpl/SALOMEDSImpl_GenericVariable.hxx
Salome HOME
Update copyrights 2014.
[modules/kernel.git] / src / SALOMEDSImpl / SALOMEDSImpl_GenericVariable.hxx
1 // Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
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 //  File   : SALOMEDSImpl_GenericVariable.hxx
21 //  Author : Roman NIKOLAEV, Open CASCADE S.A.S.
22 //  Module : SALOME
23 //
24 #ifndef _GENERICIMPL_VARIABLE_HXX_
25 #define _GENERICIMPL_VARIABLE_HXX_
26
27 #include "SALOMEDSImpl_Defines.hxx"
28
29 #include <string>
30
31 //This is base class for all variable of the Salome notebook
32
33 class SALOMEDSIMPL_EXPORT SALOMEDSImpl_GenericVariable
34 {
35  public:
36   
37   //Supported types of the nootebook variables
38   enum VariableTypes{REAL_VAR, INTEGER_VAR, BOOLEAN_VAR, STRING_VAR};
39
40   SALOMEDSImpl_GenericVariable(VariableTypes theType, const std::string& theName);
41   ~SALOMEDSImpl_GenericVariable();
42
43   VariableTypes Type() const;
44
45   std::string Name() const;
46
47   static VariableTypes String2VariableType(const std::string& theStrType);
48   
49   bool setType(const VariableTypes theType);
50
51   bool setName(const std::string& theName);
52
53   virtual std::string Save() const;
54   virtual std::string SaveToScript() const;
55   virtual std::string SaveType() const;
56
57   virtual void Load(const std::string& theStrValue);
58   
59  private:
60   VariableTypes _type;
61   std::string _name;
62 };
63
64 #endif //_GENERICIMPL_VARIABLE_HXX_