src/SMESH_I/SMESH_Hypothesis_i.hxx

   1 // Copyright (C) 2007-2011  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 //  $Header$
  28 //
  29 #ifndef _SMESH_HYPOTHESIS_I_HXX_
  30 #define _SMESH_HYPOTHESIS_I_HXX_
  31
  32 #include "SMESH.hxx"
  33
  34 #include <SALOMEconfig.h>
  35 #include CORBA_SERVER_HEADER(SMESH_Hypothesis)
  36
  37 #include "SMESH_Hypothesis.hxx"
  38 #include "SALOME_GenericObj_i.hh"
  39
  40 #include "SMESH_Gen.hxx"
  41
  42 // ======================================================
  43 // Generic hypothesis
  44 // ======================================================
  45 class SMESH_I_EXPORT SMESH_Hypothesis_i:
  46   public virtual POA_SMESH::SMESH_Hypothesis,
  47   public virtual SALOME::GenericObj_i
  48 {
  49 public:
  50   // Constructor : placed in protected section to prohibit creation of generic class instance
  51   SMESH_Hypothesis_i( PortableServer::POA_ptr thePOA );
  52
  53 public:
  54   // Destructor
  55   virtual ~SMESH_Hypothesis_i();
  56
  57   // Get type name of hypothesis
  58   char* GetName();
  59
  60   // Get plugin library name of hypothesis
  61   char* GetLibName();
  62
  63   // Set plugin library name of hypothesis
  64   void SetLibName( const char* theLibName );
  65
  66   // Get unique id of hypothesis
  67   CORBA::Long GetId();
  68
  69   // Set list of parameters  separated by ":" symbol, used for Hypothesis creation
  70   void SetParameters (const char* theParameters);
  71
  72   // Return list of notebook variables used for Hypothesis creation separated by ":" symbol
  73   char* GetParameters();
  74
  75   //Return list of last notebook variables used for Hypothesis creation.
  76   SMESH::ListOfParameters* GetLastParameters();
  77
  78   //Set last parameters for not published hypothesis
  79
  80   void SetLastParameters(const char* theParameters);
  81
  82   // Clear parameters list
  83   void ClearParameters();
  84
  85   //Return true if hypothesis was published in study
  86   bool IsPublished();
  87
  88   // Get implementation
  89   ::SMESH_Hypothesis* GetImpl();
  90
  91   // Persistence
  92   virtual char* SaveTo();
  93   virtual void  LoadFrom( const char* theStream );
  94   virtual void  UpdateAsMeshesRestored(); // for hyps needing full data restored
  95
  96 protected:
  97   ::SMESH_Hypothesis* myBaseImpl;    // base hypothesis implementation
  98 };
  99
 100 // ======================================================
 101 // Generic hypothesis creator
 102 // ======================================================
 103 class SMESH_I_EXPORT GenericHypothesisCreator_i
 104 {
 105 public:
 106   // Create a hypothesis
 107   virtual SMESH_Hypothesis_i* Create(PortableServer::POA_ptr thePOA,
 108                                      int                     theStudyId,
 109                                      ::SMESH_Gen*            theGenImpl) = 0;
 110   // return the name of IDL module
 111   virtual std::string GetModuleName() = 0;
 112 };
 113
 114 //=============================================================================
 115 //
 116 // Specific Hypothesis Creators are generated with a template which inherits a
 117 // generic hypothesis creator. Each creator returns an hypothesis of the type
 118 // given in the template.
 119 //
 120 //=============================================================================
 121 template <class T> class HypothesisCreator_i: public GenericHypothesisCreator_i
 122 {
 123 public:
 124   virtual SMESH_Hypothesis_i* Create (PortableServer::POA_ptr thePOA,
 125                                       int                     theStudyId,
 126                                       ::SMESH_Gen*            theGenImpl)
 127   {
 128     return new T (thePOA, theStudyId, theGenImpl);
 129   };
 130 };
 131
 132 #endif