src/SALOMEDSClient/SALOMEDSClient_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 SALOMEDSClient_IParameters_H
  23 #define SALOMEDSClient_IParameters_H
  24
  25 #include <string>
  26 #include <vector>
  27 #include <map>
  28
  29 #include "SALOMEDSClient_definitions.hxx"
  30 #include "SALOMEDSClient_AttributeParameter.hxx"
  31
  32 /*!
  33   Class which an interface to store the parameters of the objects
  34 */
  35 class SALOMEDSClient_IParameters
  36 {
  37 public:
  38
  39    virtual ~SALOMEDSClient_IParameters() {}
  40
  41   /*!
  42     Appends a string value to a named list.
  43     Returns a number of the added value.
  44     Note: the name of the list MUST be unique
  45    */
  46   virtual int append(const std::string& listName, const std::string& value) = 0;
  47
  48   /*!
  49     Returns a number elements in the list
  50    */
  51   virtual int nbValues(const std::string& listName) = 0;
  52
  53   /*!
  54     Returns a list of values in the list
  55    */
  56   virtual std::vector<std::string> getValues(const std::string& listName) = 0;
  57
  58   /*!
  59     Returns a value with given %index, where %index is in range [0:nbValues-1]
  60    */
  61   virtual std::string getValue(const std::string& listName, int index) = 0;
  62
  63   /*!
  64     Returns a list all entries lists
  65    */
  66   virtual std::vector<std::string> getLists() = 0;
  67
  68   /*!
  69     Sets a new named parameter value for the given entry
  70    */
  71   virtual void setParameter(const std::string& entry, const std::string& parameterName, const std::string& value) = 0;
  72
  73   /*!
  74     Gets a named parameter value for the given entry
  75    */
  76   virtual std::string getParameter(const std::string& entry, const std::string& parameterName) = 0;
  77
  78   /*!
  79     Returns all parameter names of the given entry
  80    */
  81   virtual std::vector<std::string> getAllParameterNames(const std::string& entry) = 0;
  82
  83   /*!
  84     Returns all parameter  values of the given entry
  85    */
  86   virtual std::vector<std::string> getAllParameterValues(const std::string& entry) = 0;
  87
  88   /*!
  89     Returns a number of parameters of the given entry
  90    */
  91   virtual int getNbParameters(const std::string& entry) = 0;
  92
  93   /*!
  94     Returns a list all entries
  95    */
  96   virtual std::vector<std::string> getEntries() = 0;
  97
  98   /*!
  99     Sets a global named property value
 100    */
 101   virtual void setProperty(const std::string& name, const std::string& value) = 0;
 102
 103   /*!
 104     Gets a value of global named property
 105    */
 106   virtual std::string getProperty(const std::string& name) = 0;
 107
 108   /*!
 109     Returns a list all properties
 110    */
 111   virtual std::vector<std::string> getProperties() = 0;
 112
 113   /*!
 114     Breaks a value string in two parts which is divided by %separator.
 115     If fromEnd is True the search of separator starts from the end of the string
 116    */
 117   virtual std::vector<std::string> parseValue(const std::string& value, const char separator, bool fromEnd = true) = 0;
 118
 119
 120   /*!
 121     Returns encoded entry that is a relative entry for the component
 122    */
 123   virtual std::string encodeEntry(const std::string& entry, const std::string& compName) = 0;
 124
 125   /*!
 126     Returns decoded entry that is an absolute entry
 127    */
 128   virtual std::string decodeEntry(const std::string& entry) = 0;
 129
 130   /*!
 131     Enables/Disables the dumping visual parameters, static implementation is supposed
 132    */
 133   virtual void setDumpPython(_PTR(Study) study, const std::string& theID = "") = 0;
 134
 135   /*!
 136     Returns whether there is the dumping visual parameters, static implementation is supposed
 137    */
 138   virtual bool isDumpPython(_PTR(Study) study, const std::string& theID = "") = 0;
 139
 140   /*!
 141     Returns a default name of the component where the visula parameters are stored.
 142     Static implementation is supposed
 143   */
 144   virtual std::string getDefaultVisualComponent() = 0;
 145
 146 };
 147
 148
 149 #endif