1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef SALOMEDS_IParameters_H
24 #define SALOMEDS_IParameters_H
30 #include "SALOMEDSClient.hxx"
31 #include "SALOMEDSClient_IParameters.hxx"
34 Class which an interface to store the parameters of the objects
36 class SALOMEDS_IParameters: public SALOMEDSClient_IParameters
39 SALOMEDS_IParameters(const _PTR(AttributeParameter)& ap);
41 virtual ~SALOMEDS_IParameters();
44 Appends a string value to a named list.
45 Returns a number of the added value.
46 Note: the name of the list MUST be unique
48 virtual int append(const std::string& listName, const std::string& value);
51 Returns a number elements in the list
53 virtual int nbValues(const std::string& listName);
56 Returns a list of values in the list
58 virtual std::vector<std::string> getValues(const std::string& listName);
61 Returns a value with given %index, where %index is in range [0:nbValues-1]
63 virtual std::string getValue(const std::string& listName, int index);
66 Returns a list all entries lists
68 virtual std::vector<std::string> getLists();
71 Sets a new named parameter value for the given entry
73 virtual void setParameter(const std::string& entry, const std::string& parameterName, const std::string& value);
76 Gets a named parameter value for the given entry
78 virtual std::string getParameter(const std::string& entry, const std::string& parameterName);
81 Sets an id parameter value for the given entry.
83 virtual void setIdParameter(const std::string& entry, const std::string& value);
86 Gets an id parameter value for the given entry
88 virtual std::string getIdParameter(const std::string& entry);
91 Returns all parameter names of the given entry
93 virtual std::vector<std::string> getAllParameterNames(const std::string& entry);
96 Returns all parameter values of the given entry
98 virtual std::vector<std::string> getAllParameterValues(const std::string& entry);
101 Returns a number of parameters of the given entry
103 virtual int getNbParameters(const std::string& entry);
106 Returns a list all entries
108 virtual std::vector<std::string> getEntries();
111 Sets a global named property value
113 virtual void setProperty(const std::string& name, const std::string& value);
116 Gets a value of global named property
118 virtual std::string getProperty(const std::string& name);
121 Returns a list all properties
123 virtual std::vector<std::string> getProperties();
126 Breaks a value string in two parts which is divided by %separator.
127 If fromEnd is True the search of separator starts from the end of the string
129 virtual std::vector<std::string> parseValue(const std::string& value, const char separator, bool fromEnd = true);
133 Returns encoded entry that is a relative entry for the component
135 virtual std::string encodeEntry(const std::string& entry, const std::string& compName);
138 Returns decoded entry that is an absolute entry
140 virtual std::string decodeEntry(const std::string& entry);
143 Enables/Disables the dumping visual parameters
145 virtual void setDumpPython(_PTR(Study) study, const std::string& theID = "");
148 Returns whether there is the dumping visual parameters
150 virtual bool isDumpPython(_PTR(Study) study, const std::string& theID = "");
153 Returns a default name of the component where the visula parameters are stored.
155 virtual std::string getDefaultVisualComponent();
158 _PTR(AttributeParameter) _ap;
160 std::map<std::string, std::string> _compNames;