1 // Copyright (C) 2007-2008 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
22 #ifndef SALOMEDSImpl_IParameters_H
23 #define SALOMEDSImpl_IParameters_H
25 #include "SALOMEDSImpl_Defines.hxx"
30 #include "SALOMEDSImpl_AttributeParameter.hxx"
31 #include "SALOMEDSImpl_Study.hxx"
34 Class which an interface to store the parameters of the objects
36 class SALOMEDSIMPL_EXPORT SALOMEDSImpl_IParameters
39 SALOMEDSImpl_IParameters(SALOMEDSImpl_AttributeParameter* ap);
41 virtual ~SALOMEDSImpl_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 Returns all parameter names of the given entry
83 virtual std::vector<std::string> getAllParameterNames(const std::string& entry);
86 Returns all parameter values of the given entry
88 virtual std::vector<std::string> getAllParameterValues(const std::string& entry);
91 Returns a number of parameters of the given entry
93 virtual int getNbParameters(const std::string& entry);
96 Returns a list all entries
98 virtual std::vector<std::string> getEntries();
101 Sets a global named property value
103 virtual void setProperty(const std::string& name, const std::string& value);
106 Gets a value of global named property
108 virtual std::string getProperty(const std::string& name);
111 Returns a list all properties
113 virtual std::vector<std::string> getProperties();
116 Returns decoded entry that is an absolute entry
118 virtual std::string decodeEntry(const std::string& entry);
122 Returns whether there is the dumping visual parameters
124 static bool isDumpPython(SALOMEDSImpl_Study* study, const std::string& theID = "");
127 Returns an ID of the last save point
129 static int getLastSavePoint(SALOMEDSImpl_Study* study, const std::string& theID = "");
132 Returns a Python script for the study, which sets up visual parameters
134 static std::string getStudyScript(SALOMEDSImpl_Study* study, int savePoint, const std::string& theID = "");
137 Returns a default Python script that set ups visual parameters for the given module
138 shift is a string that contain spaces to make valid Python script indentaion
140 static std::string getDefaultScript(SALOMEDSImpl_Study* study,
141 const std::string& moduleName,
142 const std::string& shift,
143 const std::string& theID = "");
146 Returns a default name of the component where the visula parameters are stored.
148 static std::string getDefaultVisualComponent();
151 SALOMEDSImpl_AttributeParameter* _ap;
152 SALOMEDSImpl_Study* _study;
153 std::map<std::string, std::string> _compNames;