-// Copyright (C) 2005 OPEN CASCADE, CEA/DEN, EDF R&D, PRINCIPIA R&D
-//
-// This library is free software; you can redistribute it and/or
-// modify it under the terms of the GNU Lesser General Public
-// License as published by the Free Software Foundation; either
-// version 2.1 of the License.
-//
-// This library is distributed in the hope that it will be useful
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
-// Lesser General Public License for more details.
+// Copyright (C) 2007-2010 CEA/DEN, EDF R&D, OPEN CASCADE
//
-// You should have received a copy of the GNU Lesser General Public
-// License along with this library; if not, write to the Free Software
-// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+// Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
+// CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
//
-// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+// This library is free software; you can redistribute it and/or
+// modify it under the terms of the GNU Lesser General Public
+// License as published by the Free Software Foundation; either
+// version 2.1 of the License.
//
+// This library is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+// Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public
+// License along with this library; if not, write to the Free Software
+// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+//
+// See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
+//
+
#ifndef SALOMEDSImpl_IParameters_H
#define SALOMEDSImpl_IParameters_H
+#include "SALOMEDSImpl_Defines.hxx"
#include <string>
#include <vector>
#include <map>
#include "SALOMEDSImpl_Study.hxx"
/*!
- Class which an interface to store the parameters of the objects
+Class which an interface to store the parameters of the objects
*/
-class Standard_EXPORT SALOMEDSImpl_IParameters
+class SALOMEDSIMPL_EXPORT SALOMEDSImpl_IParameters
{
public:
SALOMEDSImpl_IParameters(SALOMEDSImpl_AttributeParameter* ap);
virtual ~SALOMEDSImpl_IParameters();
/*!
- Appends a string value to a named list.
- Returns a number of the added value.
- Note: the name of the list MUST be unique
- */
+ Appends a string value to a named list.
+ Returns a number of the added value.
+ Note: the name of the list MUST be unique
+ */
virtual int append(const std::string& listName, const std::string& value);
/*!
- Returns a number elements in the list
- */
+ Returns a number elements in the list
+ */
virtual int nbValues(const std::string& listName);
/*!
- Returns a list of values in the list
- */
+ Returns a list of values in the list
+ */
virtual std::vector<std::string> getValues(const std::string& listName);
/*!
- Returns a value with given %index, where %index is in range [0:nbValues-1]
- */
+ Returns a value with given %index, where %index is in range [0:nbValues-1]
+ */
virtual std::string getValue(const std::string& listName, int index);
/*!
- Returns a list all entries lists
- */
+ Returns a list all entries lists
+ */
virtual std::vector<std::string> getLists();
/*!
- Sets a new named parameter value for the given entry
- */
+ Sets a new named parameter value for the given entry
+ */
virtual void setParameter(const std::string& entry, const std::string& parameterName, const std::string& value);
/*!
- Gets a named parameter value for the given entry
- */
+ Gets a named parameter value for the given entry
+ */
virtual std::string getParameter(const std::string& entry, const std::string& parameterName);
/*!
- Returns all parameter names of the given entry
- */
+ Returns all parameter names of the given entry
+ */
virtual std::vector<std::string> getAllParameterNames(const std::string& entry);
/*!
- Returns all parameter values of the given entry
- */
+ Returns all parameter values of the given entry
+ */
virtual std::vector<std::string> getAllParameterValues(const std::string& entry);
/*!
- Returns a number of parameters of the given entry
- */
+ Returns a number of parameters of the given entry
+ */
virtual int getNbParameters(const std::string& entry);
/*!
- Returns a list all entries
- */
+ Returns a list all entries
+ */
virtual std::vector<std::string> getEntries();
/*!
- Sets a global named property value
- */
+ Sets a global named property value
+ */
virtual void setProperty(const std::string& name, const std::string& value);
/*!
- Gets a value of global named property
- */
+ Gets a value of global named property
+ */
virtual std::string getProperty(const std::string& name);
/*!
- Returns a list all properties
- */
+ Returns a list all properties
+ */
virtual std::vector<std::string> getProperties();
/*!
- Returns decoded entry that is an absolute entry
- */
+ Returns decoded entry that is an absolute entry
+ */
virtual std::string decodeEntry(const std::string& entry);
/*!
- Returns whether there is the dumping visual parameters
- */
+ Returns whether there is the dumping visual parameters
+ */
static bool isDumpPython(SALOMEDSImpl_Study* study, const std::string& theID = "");
/*!
- Returns an ID of the last save point
+ Returns an ID of the last save point
*/
static int getLastSavePoint(SALOMEDSImpl_Study* study, const std::string& theID = "");
/*!
- Returns a Python script for the study, which sets up visual parameters
+ Returns a Python script for the study, which sets up visual parameters
*/
static std::string getStudyScript(SALOMEDSImpl_Study* study, int savePoint, const std::string& theID = "");
/*!
- Returns a default Python script that set ups visual parameters for the given module
- shift is a string that contain spaces to make valid Python script indentaion
+ Returns a default Python script that set ups visual parameters for the given module
+ shift is a string that contain spaces to make valid Python script indentaion
*/
static std::string getDefaultScript(SALOMEDSImpl_Study* study,
- const std::string& moduleName,
- const std::string& shift,
- const std::string& theID = "");
+ const std::string& moduleName,
+ const std::string& shift,
+ const std::string& theID = "");
/*!
- Returns a default name of the component where the visula parameters are stored.
+ Returns a default name of the component where the visula parameters are stored.
*/
static std::string getDefaultVisualComponent();
