src/SALOMEDSImpl/SALOMEDSImpl_IParameters.hxx

   1 //  Copyright (C) 2007-2008  CEA/DEN, EDF R&D, 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.
  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 #ifndef SALOMEDSImpl_IParameters_H
  23 #define SALOMEDSImpl_IParameters_H
  24
  25 #include "SALOMEDSImpl_Defines.hxx"
  26 #include <string>
  27 #include <vector>
  28 #include <map>
  29
  30 #include "SALOMEDSImpl_AttributeParameter.hxx"
  31 #include "SALOMEDSImpl_Study.hxx"
  32
  33 /*!
  34 Class which an interface to store the parameters of the objects
  35 */
  36 class  SALOMEDSIMPL_EXPORT SALOMEDSImpl_IParameters
  37 {
  38 public:
  39   SALOMEDSImpl_IParameters(SALOMEDSImpl_AttributeParameter* ap);
  40
  41   virtual ~SALOMEDSImpl_IParameters();
  42
  43   /*!
  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
  47   */
  48   virtual int append(const std::string& listName, const std::string& value);
  49
  50   /*!
  51   Returns a number elements in the list
  52   */
  53   virtual int nbValues(const std::string& listName);
  54
  55   /*!
  56   Returns a list of values in the list
  57   */
  58   virtual std::vector<std::string> getValues(const std::string& listName);
  59
  60   /*!
  61   Returns a value with given %index, where %index is in range [0:nbValues-1]
  62   */
  63   virtual std::string getValue(const std::string& listName, int index);
  64
  65   /*!
  66   Returns a list all entries lists
  67   */
  68   virtual std::vector<std::string> getLists();
  69
  70   /*!
  71   Sets a new named parameter value for the given entry
  72   */
  73   virtual void setParameter(const std::string& entry, const std::string& parameterName, const std::string& value);
  74
  75   /*!
  76   Gets a named parameter value for the given entry
  77   */
  78   virtual std::string getParameter(const std::string& entry, const std::string& parameterName);
  79
  80   /*!
  81   Returns all parameter names of the given entry
  82   */
  83   virtual std::vector<std::string> getAllParameterNames(const std::string& entry);
  84
  85   /*!
  86   Returns all parameter  values of the given entry
  87   */
  88   virtual std::vector<std::string> getAllParameterValues(const std::string& entry);
  89
  90   /*!
  91   Returns a number of parameters of the given entry
  92   */
  93   virtual int getNbParameters(const std::string& entry);
  94
  95   /*!
  96   Returns a list all entries
  97   */
  98   virtual std::vector<std::string> getEntries();
  99
 100   /*!
 101   Sets a global named property value
 102   */
 103   virtual void setProperty(const std::string& name, const std::string& value);
 104
 105   /*!
 106   Gets a value of global named property
 107   */
 108   virtual std::string getProperty(const std::string& name);
 109
 110   /*!
 111   Returns a list all properties
 112   */
 113   virtual std::vector<std::string> getProperties();
 114
 115   /*!
 116   Returns decoded entry that is an absolute entry
 117   */
 118   virtual std::string decodeEntry(const std::string& entry);
 119
 120
 121   /*!
 122   Returns whether there is the dumping visual parameters
 123   */
 124   static bool isDumpPython(SALOMEDSImpl_Study* study, const std::string& theID = "");
 125
 126   /*!
 127   Returns an ID of the last save point
 128   */
 129   static int getLastSavePoint(SALOMEDSImpl_Study* study, const std::string& theID = "");
 130
 131   /*!
 132   Returns a Python script for the study, which sets up visual parameters
 133   */
 134   static std::string getStudyScript(SALOMEDSImpl_Study* study, int savePoint, const std::string& theID = "");
 135
 136   /*!
 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
 139   */
 140   static std::string getDefaultScript(SALOMEDSImpl_Study* study,
 141     const std::string& moduleName,
 142     const std::string& shift,
 143     const std::string& theID = "");
 144
 145   /*!
 146   Returns a default name of the component where the visula parameters are stored.
 147   */
 148   static std::string getDefaultVisualComponent();
 149
 150 private:
 151   SALOMEDSImpl_AttributeParameter* _ap;
 152   SALOMEDSImpl_Study* _study;
 153   std::map<std::string, std::string> _compNames;
 154 };
 155
 156
 157 #endif