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