src/SMESH_I/SMESH_Hypothesis_i.hxx

   1 // Copyright (C) 2007-2012  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 //  SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
  24 //  File   : SMESH_Hypothesis_i.hxx
  25 //  Author : Paul RASCLE, EDF
  26 //  Module : SMESH
  27 //
  28 #ifndef _SMESH_HYPOTHESIS_I_HXX_
  29 #define _SMESH_HYPOTHESIS_I_HXX_
  30
  31 #include "SMESH.hxx"
  32
  33 #include <SALOMEconfig.h>
  34 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
  35
  36 #include "SMESH_Hypothesis.hxx"
  37 #include "SALOME_GenericObj_i.hh"
  38
  39 #include "SMESH_Gen.hxx"
  40
  41 #include <map>
  42 #include <string>
  43
  44 class TCollection_AsciiString;
  45
  46 // ======================================================
  47 // Generic hypothesis
  48 // ======================================================
  49 class SMESH_I_EXPORT SMESH_Hypothesis_i:
  50   public virtual POA_SMESH::SMESH_Hypothesis,
  51   public virtual SALOME::GenericObj_i
  52 {
  53 public:
  54   // Constructor : placed in protected section to prohibit creation of generic class instance
  55   SMESH_Hypothesis_i( PortableServer::POA_ptr thePOA );
  56
  57 public:
  58   // Destructor
  59   virtual ~SMESH_Hypothesis_i();
  60
  61   // Get type name of hypothesis
  62   char* GetName();
  63
  64   // Get plugin library name of hypothesis
  65   char* GetLibName();
  66
  67   // Set plugin library name of hypothesis
  68   void SetLibName( const char* theLibName );
  69
  70   // Get unique id of hypothesis
  71   CORBA::Long GetId();
  72
  73   // Set the variable parameter; method is a name of method setting this parameter.
  74   // This method must be called by the hypothesis creator just before calling hyp->method()
  75   void SetVarParameter (const char* parameter, const char* method);
  76
  77   // Return the variable parameter used for Hypothesis creation by name of method
  78   // setting this parameter
  79   char* GetVarParameter (const char* methodName);
  80
  81   // Set list of parameters  separated by ":" symbol, used for Hypothesis creation
  82   void SetParameters (const char* theParameters);
  83
  84   // Return list of notebook variables used for Hypothesis creation separated by ":" symbol
  85   char* GetParameters();
  86
  87   //Return list of last notebook variables used for Hypothesis creation.
  88   SMESH::ListOfParameters* GetLastParameters();
  89
  90   //Set last parameters for not published hypothesis
  91
  92   void SetLastParameters(const char* theParameters);
  93
  94   // Clear parameters list
  95   void ClearParameters();
  96
  97   //Return true if hypothesis was published in study
  98   bool IsPublished();
  99
 100   // Get implementation
 101   ::SMESH_Hypothesis* GetImpl();
 102
 103   // Persistence
 104   virtual char* SaveTo();
 105   virtual void  LoadFrom( const char* theStream );
 106   virtual void  UpdateAsMeshesRestored(); // for hyps needing full data restored
 107
 108 protected:
 109   ::SMESH_Hypothesis*          myBaseImpl;    // base hypothesis implementation
 110
 111   std::map< std::string, std::string > myMethod2VarParams; // variable parameters
 112
 113
 114  public:
 115   // Methods for backward compatibility of notebook variables
 116
 117   // restore myMethod2VarParams by parameters stored in an old study
 118   virtual void setOldParameters (const char* theParameters);
 119
 120   // method used to convert variable parameters stored in an old study
 121   // into myMethod2VarParams. It should return a method name for an index of
 122   // variable parameters. Index is countered from zero
 123   virtual std::string getMethodOfParameter(const int paramIndex, int nbVars) const { return ""; }
 124
 125   // method intended to remove explicit treatment of Netgen hypotheses from SMESH_NoteBook
 126   virtual int getParamIndex(const TCollection_AsciiString& method, int nbVars) const { return -1; }
 127 };
 128
 129 // ======================================================
 130 // Generic hypothesis creator
 131 // ======================================================
 132 class SMESH_I_EXPORT GenericHypothesisCreator_i
 133 {
 134 public:
 135   // Create a hypothesis
 136   virtual SMESH_Hypothesis_i* Create(PortableServer::POA_ptr thePOA,
 137                                      int                     theStudyId,
 138                                      ::SMESH_Gen*            theGenImpl) = 0;
 139   // return the name of IDL module
 140   virtual std::string GetModuleName() = 0;
 141 };
 142
 143 //=============================================================================
 144 //
 145 // Specific Hypothesis Creators are generated with a template which inherits a
 146 // generic hypothesis creator. Each creator returns an hypothesis of the type
 147 // given in the template.
 148 //
 149 //=============================================================================
 150 template <class T> class HypothesisCreator_i: public GenericHypothesisCreator_i
 151 {
 152 public:
 153   virtual SMESH_Hypothesis_i* Create (PortableServer::POA_ptr thePOA,
 154                                       int                     theStudyId,
 155                                       ::SMESH_Gen*            theGenImpl)
 156   {
 157     return new T (thePOA, theStudyId, theGenImpl);
 158   };
 159 };
 160
 161 #endif