Version: 9.15.0
SALOMEDSClient_IParameters.hxx
Go to the documentation of this file.
1 // Copyright (C) 2007-2025 CEA, EDF, 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 SALOMEDSClient_IParameters_H
24 #define SALOMEDSClient_IParameters_H
25 
26 #include <string>
27 #include <vector>
28 #include <map>
29 
32 
37 {
38 public:
39 
41 
47  virtual int append(const std::string& listName, const std::string& value) = 0;
48 
52  virtual int nbValues(const std::string& listName) = 0;
53 
57  virtual std::vector<std::string> getValues(const std::string& listName) = 0;
58 
62  virtual std::string getValue(const std::string& listName, int index) = 0;
63 
67  virtual std::vector<std::string> getLists() = 0;
68 
72  virtual void setParameter(const std::string& entry, const std::string& parameterName, const std::string& value) = 0;
73 
77  virtual std::string getParameter(const std::string& entry, const std::string& parameterName) = 0;
78 
82  virtual void setIdParameter(const std::string& entry, const std::string& value) = 0;
83 
87  virtual std::string getIdParameter(const std::string& entry) = 0;
88 
92  virtual std::vector<std::string> getAllParameterNames(const std::string& entry) = 0;
93 
97  virtual std::vector<std::string> getAllParameterValues(const std::string& entry) = 0;
98 
102  virtual int getNbParameters(const std::string& entry) = 0;
103 
107  virtual std::vector<std::string> getEntries() = 0;
108 
112  virtual void setProperty(const std::string& name, const std::string& value) = 0;
113 
117  virtual std::string getProperty(const std::string& name) = 0;
118 
122  virtual std::vector<std::string> getProperties() = 0;
123 
128  virtual std::vector<std::string> parseValue(const std::string& value, const char separator, bool fromEnd = true) = 0;
129 
130 
134  virtual std::string encodeEntry(const std::string& entry, const std::string& compName) = 0;
135 
139  virtual std::string decodeEntry(const std::string& entry) = 0;
140 
144  virtual void setDumpPython(const std::string& theID = "") = 0;
145 
149  virtual bool isDumpPython(const std::string& theID = "") = 0;
150 
155  virtual std::string getDefaultVisualComponent() = 0;
156 
157 };
158 
159 
160 #endif
Class which an interface to store the parameters of the objects.
Definition: SALOMEDSClient_IParameters.hxx:37
virtual std::vector< std::string > getAllParameterNames(const std::string &entry)=0
Returns all parameter names of the given entry.
virtual int nbValues(const std::string &listName)=0
Returns a number elements in the list.
virtual int append(const std::string &listName, const std::string &value)=0
Appends a string value to a named list.
virtual void setIdParameter(const std::string &entry, const std::string &value)=0
Sets an id parameter value for the given entry.
virtual std::string getDefaultVisualComponent()=0
Returns a default name of the component where the visula parameters are stored.
virtual ~SALOMEDSClient_IParameters()
Definition: SALOMEDSClient_IParameters.hxx:40
virtual std::string encodeEntry(const std::string &entry, const std::string &compName)=0
Returns encoded entry that is a relative entry for the component.
virtual std::vector< std::string > getValues(const std::string &listName)=0
Returns a list of values in the list.
virtual std::vector< std::string > getLists()=0
Returns a list all entries lists.
virtual void setDumpPython(const std::string &theID="")=0
Enables/Disables the dumping visual parameters, static implementation is supposed.
virtual std::string decodeEntry(const std::string &entry)=0
Returns decoded entry that is an absolute entry.
virtual std::string getIdParameter(const std::string &entry)=0
Gets an id parameter value for the given entry.
virtual std::vector< std::string > getEntries()=0
Returns a list all entries.
virtual void setProperty(const std::string &name, const std::string &value)=0
Sets a global named property value.
virtual void setParameter(const std::string &entry, const std::string &parameterName, const std::string &value)=0
Sets a new named parameter value for the given entry.
virtual std::vector< std::string > parseValue(const std::string &value, const char separator, bool fromEnd=true)=0
Breaks a value string in two parts which is divided by separator.
virtual std::string getValue(const std::string &listName, int index)=0
Returns a value with given index, where index is in range [0:nbValues-1].
virtual std::vector< std::string > getProperties()=0
Returns a list all properties.
virtual std::vector< std::string > getAllParameterValues(const std::string &entry)=0
Returns all parameter values of the given entry.
virtual int getNbParameters(const std::string &entry)=0
Returns a number of parameters of the given entry.
virtual std::string getProperty(const std::string &name)=0
Gets a value of global named property.
virtual std::string getParameter(const std::string &entry, const std::string &parameterName)=0
Gets a named parameter value for the given entry.
virtual bool isDumpPython(const std::string &theID="")=0
Returns whether there is the dumping visual parameters, static implementation is supposed.
string name
Definition: pythfilter.py:56
index
Definition: python_test_driver.py:105