src/SALOMEDSImpl/SALOMEDSImpl_IParameters.hxx

   1 // Copyright (C) 2007-2016  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, or (at your option) any later version.
  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     Sets an id parameter value for the given entry.
  83    */
  84   virtual void setIdParameter(const std::string& entry, const std::string& value);
  85
  86   /*!
  87     Gets an id parameter value for the given entry
  88    */
  89   virtual std::string getIdParameter(const std::string& entry);
  90
  91   /*!
  92   Returns all parameter names of the given entry
  93   */
  94   virtual std::vector<std::string> getAllParameterNames(const std::string& entry);
  95
  96   /*!
  97   Returns all parameter  values of the given entry
  98   */
  99   virtual std::vector<std::string> getAllParameterValues(const std::string& entry);
 100
 101   /*!
 102   Returns a number of parameters of the given entry
 103   */
 104   virtual int getNbParameters(const std::string& entry);
 105
 106   /*!
 107   Returns a list all entries
 108   */
 109   virtual std::vector<std::string> getEntries();
 110
 111   /*!
 112   Sets a global named property value
 113   */
 114   virtual void setProperty(const std::string& name, const std::string& value);
 115
 116   /*!
 117   Gets a value of global named property
 118   */
 119   virtual std::string getProperty(const std::string& name);
 120
 121   /*!
 122   Returns a list all properties
 123   */
 124   virtual std::vector<std::string> getProperties();
 125
 126   /*!
 127   Returns decoded entry that is an absolute entry
 128   */
 129   virtual std::string decodeEntry(const std::string& entry);
 130
 131
 132   /*!
 133   Returns whether there is the dumping visual parameters
 134   */
 135   static bool isDumpPython(SALOMEDSImpl_Study* study, const std::string& theID = "");
 136
 137   /*!
 138   Returns an ID of the last save point
 139   */
 140   static int getLastSavePoint(SALOMEDSImpl_Study* study, const std::string& theID = "");
 141
 142   /*!
 143   Returns a Python script for the study, which sets up visual parameters
 144   */
 145   static std::string getStudyScript(SALOMEDSImpl_Study* study, int savePoint, const std::string& theID = "");
 146
 147   /*!
 148   Returns a default Python script that set ups visual parameters for the given module
 149   shift is a string that contain spaces to make valid Python script indentaion
 150   */
 151   static std::string getDefaultScript(SALOMEDSImpl_Study* study,
 152     const std::string& moduleName,
 153     const std::string& shift,
 154     const std::string& theID = "");
 155
 156   /*!
 157   Returns a default name of the component where the visula parameters are stored.
 158   */
 159   static std::string getDefaultVisualComponent();
 160
 161 private:
 162   SALOMEDSImpl_AttributeParameter* _ap;
 163   SALOMEDSImpl_Study* _study;
 164   std::map<std::string, std::string> _compNames;
 165 };
 166
 167
 168 #endif