Version: 8.3.0
SALOMEDSImpl_IParameters.hxx
Go to the documentation of this file.
1 // Copyright (C) 2007-2016 CEA/DEN, EDF R&D, OPEN CASCADE
2 //
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
5 //
6 // This library is free software; you can redistribute it and/or
7 // modify it under the terms of the GNU Lesser General Public
8 // License as published by the Free Software Foundation; either
9 // version 2.1 of the License, or (at your option) any later version.
10 //
11 // This library is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 // Lesser General Public License for more details.
15 //
16 // You should have received a copy of the GNU Lesser General Public
17 // License along with this library; if not, write to the Free Software
18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 //
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 //
22 
23 #ifndef SALOMEDSImpl_IParameters_H
24 #define SALOMEDSImpl_IParameters_H
25 
26 #include "SALOMEDSImpl_Defines.hxx"
27 #include <string>
28 #include <vector>
29 #include <map>
30 
32 #include "SALOMEDSImpl_Study.hxx"
33 
38 {
39 public:
41 
42  virtual ~SALOMEDSImpl_IParameters();
43 
49  virtual int append(const std::string& listName, const std::string& value);
50 
54  virtual int nbValues(const std::string& listName);
55 
59  virtual std::vector<std::string> getValues(const std::string& listName);
60 
64  virtual std::string getValue(const std::string& listName, int index);
65 
69  virtual std::vector<std::string> getLists();
70 
74  virtual void setParameter(const std::string& entry, const std::string& parameterName, const std::string& value);
75 
79  virtual std::string getParameter(const std::string& entry, const std::string& parameterName);
80 
84  virtual void setIdParameter(const std::string& entry, const std::string& value);
85 
89  virtual std::string getIdParameter(const std::string& entry);
90 
94  virtual std::vector<std::string> getAllParameterNames(const std::string& entry);
95 
99  virtual std::vector<std::string> getAllParameterValues(const std::string& entry);
100 
104  virtual int getNbParameters(const std::string& entry);
105 
109  virtual std::vector<std::string> getEntries();
110 
114  virtual void setProperty(const std::string& name, const std::string& value);
115 
119  virtual std::string getProperty(const std::string& name);
120 
124  virtual std::vector<std::string> getProperties();
125 
129  virtual std::string decodeEntry(const std::string& entry);
130 
131 
135  static bool isDumpPython(SALOMEDSImpl_Study* study, const std::string& theID = "");
136 
140  static int getLastSavePoint(SALOMEDSImpl_Study* study, const std::string& theID = "");
141 
145  static std::string getStudyScript(SALOMEDSImpl_Study* study, int savePoint, const std::string& theID = "");
146 
151  static std::string getDefaultScript(SALOMEDSImpl_Study* study,
152  const std::string& moduleName,
153  const std::string& shift,
154  const std::string& theID = "");
155 
159  static std::string getDefaultVisualComponent();
160 
161 private:
164  std::map<std::string, std::string> _compNames;
165 };
166 
167 
168 #endif