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   // Get internal entry of hypothesis
  69   virtual char* GetEntry();
  70
  71   // Get name of the component
  72   virtual char* GetComponent();
  73
  74   // Get validity status of hypothesis
  75   virtual CORBA::Boolean IsValid();
  76
  77   // Set list of parameters, used for Hypothesis creation
  78   virtual void SetParameters( SALOME::Notebook_ptr theNotebook, const SALOME::StringArray& theParameters );
  79
  80   // Return list of notebook variables used for Hypothesis creation
  81   virtual SALOME::StringArray* GetParameters();
  82
  83   // Update hypothesis according to the SALOME Notebook
  84   virtual void Update( SALOME::Notebook_ptr theNotebook );
  85
  86   // Update string attribute of hypothesis
  87   virtual void UpdateStringAttribute();
  88
  89   //Return true if hypothesis was published in study
  90   bool IsPublished();
  91
  92   // Get implementation
  93   ::SMESH_Hypothesis* GetImpl();
  94
  95   // Persistence
  96   virtual char* SaveTo();
  97   virtual void  LoadFrom( const char* theStream );
  98
  99 protected:
 100   ::SMESH_Hypothesis* myBaseImpl;    // base hypothesis implementation
 101 };
 102
 103 // ======================================================
 104 // Generic hypothesis creator
 105 // ======================================================
 106 class SMESH_I_EXPORT GenericHypothesisCreator_i
 107 {
 108 public:
 109   // Create a hypothesis
 110   virtual SMESH_Hypothesis_i* Create(PortableServer::POA_ptr thePOA,
 111                                      int                     theStudyId,
 112                                      ::SMESH_Gen*            theGenImpl) = 0;
 113   // return the name of IDL module
 114   virtual std::string GetModuleName() = 0;
 115 };
 116
 117 //=============================================================================
 118 //
 119 // Specific Hypothesis Creators are generated with a template which inherits a
 120 // generic hypothesis creator. Each creator returns an hypothesis of the type
 121 // given in the template.
 122 //
 123 //=============================================================================
 124 template <class T> class HypothesisCreator_i: public GenericHypothesisCreator_i
 125 {
 126 public:
 127   virtual SMESH_Hypothesis_i* Create (PortableServer::POA_ptr thePOA,
 128                                       int                     theStudyId,
 129                                       ::SMESH_Gen*            theGenImpl)
 130   {
 131     return new T (thePOA, theStudyId, theGenImpl);
 132   };
 133 };
 134
 135 #endif