src/SALOMEDS/SALOMEDS_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 SALOMEDS_IParameters_H
  24 #define SALOMEDS_IParameters_H
  25
  26 #include <string>
  27 #include <vector>
  28 #include <map>
  29
  30 #include "SALOMEDSClient.hxx"
  31 #include "SALOMEDSClient_IParameters.hxx"
  32
  33 /*!
  34   Class which an interface to store the parameters of the objects
  35 */
  36 class SALOMEDS_IParameters: public SALOMEDSClient_IParameters
  37 {
  38 public:
  39   SALOMEDS_IParameters(const _PTR(AttributeParameter)& ap);
  40
  41   virtual ~SALOMEDS_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     Breaks a value string in two parts which is divided by %separator.
 117     If fromEnd is True the search of separator starts from the end of the string
 118    */
 119   virtual std::vector<std::string> parseValue(const std::string& value, const char separator, bool fromEnd = true);
 120
 121
 122   /*!
 123     Returns encoded entry that is a relative entry for the component
 124    */
 125   virtual std::string encodeEntry(const std::string& entry, const std::string& compName);
 126
 127   /*!
 128     Returns decoded entry that is an absolute entry
 129    */
 130   virtual std::string decodeEntry(const std::string& entry);
 131
 132   /*!
 133     Enables/Disables the dumping visual parameters
 134    */
 135   virtual void setDumpPython(_PTR(Study) study, const std::string& theID = "");
 136
 137   /*!
 138     Returns whether there is the dumping visual parameters
 139    */
 140   virtual bool isDumpPython(_PTR(Study) study, const std::string& theID = "");
 141
 142   /*!
 143     Returns a default name of the component where the visula parameters are stored.
 144   */
 145   virtual std::string getDefaultVisualComponent();
 146
 147 private:
 148   _PTR(AttributeParameter) _ap;
 149   _PTR(Study) _study;
 150   std::map<std::string, std::string> _compNames;
 151 };
 152
 153
 154 #endif