src/SALOMEDSImpl/SALOMEDSImpl_IParameters.hxx

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