Version: 9.15.0
SALOMEDS_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 SALOMEDS_IParameters_H
24 #define SALOMEDS_IParameters_H
25 
26 #include <string>
27 #include <vector>
28 #include <map>
29 
30 #include "SALOMEDSClient.hxx"
32 
37 {
38 public:
39  SALOMEDS_IParameters(const _PTR(AttributeParameter)& ap);
40 
41  virtual ~SALOMEDS_IParameters();
42 
48  virtual int append(const std::string& listName, const std::string& value);
49 
53  virtual int nbValues(const std::string& listName);
54 
58  virtual std::vector<std::string> getValues(const std::string& listName);
59 
63  virtual std::string getValue(const std::string& listName, int index);
64 
68  virtual std::vector<std::string> getLists();
69 
73  virtual void setParameter(const std::string& entry, const std::string& parameterName, const std::string& value);
74 
78  virtual std::string getParameter(const std::string& entry, const std::string& parameterName);
79 
83  virtual void setIdParameter(const std::string& entry, const std::string& value);
84 
88  virtual std::string getIdParameter(const std::string& entry);
89 
93  virtual std::vector<std::string> getAllParameterNames(const std::string& entry);
94 
98  virtual std::vector<std::string> getAllParameterValues(const std::string& entry);
99 
103  virtual int getNbParameters(const std::string& entry);
104 
108  virtual std::vector<std::string> getEntries();
109 
113  virtual void setProperty(const std::string& name, const std::string& value);
114 
118  virtual std::string getProperty(const std::string& name);
119 
123  virtual std::vector<std::string> getProperties();
124 
129  virtual std::vector<std::string> parseValue(const std::string& value, const char separator, bool fromEnd = true);
130 
131 
135  virtual std::string encodeEntry(const std::string& entry, const std::string& compName);
136 
140  virtual std::string decodeEntry(const std::string& entry);
141 
145  virtual void setDumpPython(const std::string& theID = "");
146 
150  virtual bool isDumpPython(const std::string& theID = "");
151 
155  virtual std::string getDefaultVisualComponent();
156 
157 private:
158  _PTR(AttributeParameter) _ap;
159  std::map<std::string, std::string> _compNames;
160 };
161 
162 
163 #endif
Class which an interface to store the parameters of the objects.
Definition: SALOMEDSClient_IParameters.hxx:37
Class which an interface to store the parameters of the objects.
Definition: SALOMEDS_IParameters.hxx:37
std::map< std::string, std::string > _compNames
Definition: SALOMEDS_IParameters.hxx:159
virtual std::vector< std::string > getAllParameterNames(const std::string &entry)
Returns all parameter names of the given entry.
Definition: SALOMEDS_IParameters.cxx:137
_PTR(AttributeParameter) _ap
virtual std::vector< std::string > getEntries()
Returns a list all entries.
Definition: SALOMEDS_IParameters.cxx:197
SALOMEDS_IParameters(const _PTR(AttributeParameter)&ap)
Constructor.
Definition: SALOMEDS_IParameters.cxx:47
virtual std::string getProperty(const std::string &name)
Gets a value of global named property.
Definition: SALOMEDS_IParameters.cxx:214
virtual void setProperty(const std::string &name, const std::string &value)
Sets a global named property value.
Definition: SALOMEDS_IParameters.cxx:205
virtual bool isDumpPython(const std::string &theID="")
Returns whether there is the dumping visual parameters.
Definition: SALOMEDS_IParameters.cxx:290
virtual std::string encodeEntry(const std::string &entry, const std::string &compName)
Returns encoded entry that is a relative entry for the component.
Definition: SALOMEDS_IParameters.cxx:251
virtual int nbValues(const std::string &listName)
Returns a number elements in the list.
Definition: SALOMEDS_IParameters.cxx:76
virtual void setIdParameter(const std::string &entry, const std::string &value)
Sets an id parameter value for the given entry.
Definition: SALOMEDS_IParameters.cxx:163
virtual void setParameter(const std::string &entry, const std::string &parameterName, const std::string &value)
Sets a new named parameter value for the given entry.
Definition: SALOMEDS_IParameters.cxx:109
virtual ~SALOMEDS_IParameters()
Definition: SALOMEDS_IParameters.cxx:53
virtual std::string decodeEntry(const std::string &entry)
Returns decoded entry that is an absolute entry.
Definition: SALOMEDS_IParameters.cxx:259
virtual std::string getValue(const std::string &listName, int index)
Returns a value with given index, where index is in range [0:nbValues-1].
Definition: SALOMEDS_IParameters.cxx:93
virtual std::string getIdParameter(const std::string &entry)
Gets an id parameter value for the given entry.
Definition: SALOMEDS_IParameters.cxx:151
virtual int append(const std::string &listName, const std::string &value)
Appends a string value to a named list.
Definition: SALOMEDS_IParameters.cxx:58
virtual std::string getParameter(const std::string &entry, const std::string &parameterName)
Gets a named parameter value for the given entry.
Definition: SALOMEDS_IParameters.cxx:124
virtual std::vector< std::string > getValues(const std::string &listName)
Returns a list of values in the list.
Definition: SALOMEDS_IParameters.cxx:84
virtual int getNbParameters(const std::string &entry)
Returns a number of parameters of the given entry.
Definition: SALOMEDS_IParameters.cxx:190
virtual std::vector< std::string > getLists()
Returns a list all entries lists.
Definition: SALOMEDS_IParameters.cxx:102
virtual std::vector< std::string > getProperties()
Returns a list all properties.
Definition: SALOMEDS_IParameters.cxx:221
virtual std::vector< std::string > getAllParameterValues(const std::string &entry)
Returns all parameter values of the given entry.
Definition: SALOMEDS_IParameters.cxx:177
virtual std::vector< std::string > parseValue(const std::string &value, const char separator, bool fromEnd=true)
Breaks a value string in two parts which is divided by separator.
Definition: SALOMEDS_IParameters.cxx:230
virtual void setDumpPython(const std::string &theID="")
Enables/Disables the dumping visual parameters.
Definition: SALOMEDS_IParameters.cxx:280
virtual std::string getDefaultVisualComponent()
Returns a default name of the component where the visula parameters are stored.
Definition: SALOMEDS_IParameters.cxx:302
string name
Definition: pythfilter.py:56
index
Definition: python_test_driver.py:105