src/SMESH_I/SMESH_Hypothesis_i.hxx

   1 // Copyright (C) 2007-2014  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 //  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 (a variable name or a parameter value); \a method is a name
  74   // of method setting this parameter.
  75   // This method must be called by the hypothesis creator just before calling hyp->method()
  76   void SetVarParameter (const char* parameter, const char* method);
  77
  78   // Return the variable parameter used at Hypothesis Creation by the name of method
  79   // setting this parameter. The returned variable name is used at Hypothesis Edition.
  80   char* GetVarParameter (const char* methodName);
  81
  82   // Store a hypothesis wrapping this not published one. This hyp, which has
  83   // no own parameters but is published, is used to store variables defining parameters
  84   // of this hypothesis. This method is to be called before setting parameters
  85   // of this hypothesis.
  86   void SetHolderHypothesis(const SMESH::SMESH_Hypothesis_ptr hyp);
  87
  88   //Return true if hypothesis was published in study
  89   bool IsPublished();
  90
  91   // Get implementation
  92   ::SMESH_Hypothesis* GetImpl();
  93
  94   // Persistence
  95   virtual char* SaveTo();
  96   virtual void  LoadFrom( const char* theStream );
  97   virtual void  UpdateAsMeshesRestored(); // for hyps needing full data restored
  98
  99  protected:
 100
 101   // base hypothesis implementation
 102   ::SMESH_Hypothesis*         myBaseImpl;
 103
 104   // a published hypothesis wrapping this not published one
 105   SMESH::SMESH_Hypothesis_var myHolder;
 106
 107   // variable parameters
 108   std::map< std::string, std::string > myMethod2VarParams;
 109
 110  public:
 111   // Methods for backward compatibility of notebook variables
 112
 113   // restore myMethod2VarParams by parameters stored in an old study
 114   virtual void setOldParameters (const char* theParameters);
 115
 116   // method used to convert variable parameters stored in an old study
 117   // into myMethod2VarParams. It should return a method name for an index of
 118   // variable parameters. Index is countered from zero
 119   virtual std::string getMethodOfParameter(const int paramIndex, int nbVars) const { return ""; }
 120
 121   // method intended to remove explicit treatment of Netgen hypotheses from SMESH_NoteBook
 122   virtual int getParamIndex(const TCollection_AsciiString& method, int nbVars) const { return -1; }
 123 };
 124
 125 // ======================================================
 126 // Generic hypothesis creator
 127 // ======================================================
 128 class SMESH_I_EXPORT GenericHypothesisCreator_i
 129 {
 130 public:
 131   // Create a hypothesis
 132   virtual SMESH_Hypothesis_i* Create(PortableServer::POA_ptr thePOA,
 133                                      int                     theStudyId,
 134                                      ::SMESH_Gen*            theGenImpl) = 0;
 135   // return the name of IDL module
 136   virtual std::string GetModuleName() = 0;
 137   virtual bool IsApplicable( const TopoDS_Shape &S, bool toCheckAll ) {return true;}
 138 };
 139
 140 //=============================================================================
 141 //
 142 // Specific Hypothesis Creators are generated with a template which inherits a
 143 // generic hypothesis creator. Each creator returns an hypothesis of the type
 144 // given in the template.
 145 //
 146 //=============================================================================
 147 template <class T> class HypothesisCreator_i: public GenericHypothesisCreator_i
 148 {
 149 public:
 150   virtual SMESH_Hypothesis_i* Create (PortableServer::POA_ptr thePOA,
 151                                       int                     theStudyId,
 152                                       ::SMESH_Gen*            theGenImpl)
 153   {
 154     return new T (thePOA, theStudyId, theGenImpl);
 155   };
 156 };
 157
 158 #endif