Salome HOME
#24666 [CEA][Windows] BLSURPLUGIN compilation issue
[modules/smesh.git] / src / SMESH_I / SMESH_Hypothesis_i.hxx
index 5cc8e54d961ecf6c7a29b7c7da6c042eedc8c49a..2b58ebdad168560e870ab815893592b522747c29 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2014  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2021  CEA/DEN, EDF R&D, OPEN CASCADE
 //
 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
@@ -20,7 +20,7 @@
 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 //
 
-//  SMESH SMESH_I : idl implementation based on 'SMESH' unit's calsses
+//  SMESH SMESH_I : idl implementation based on 'SMESH' unit's classes
 //  File   : SMESH_Hypothesis_i.hxx
 //  Author : Paul RASCLE, EDF
 //  Module : SMESH
@@ -40,6 +40,7 @@
 
 #include <map>
 #include <string>
+#include <vector>
 
 class TCollection_AsciiString;
 
@@ -59,31 +60,34 @@ public:
   virtual ~SMESH_Hypothesis_i();
 
   // Get type name of hypothesis
-  char* GetName();
+  virtual char* GetName();
 
   // Get plugin library name of hypothesis
-  char* GetLibName();
+  virtual char* GetLibName();
 
   // Set plugin library name of hypothesis
   void SetLibName( const char* theLibName );
 
   // Get unique id of hypothesis
-  CORBA::Long GetId();
-  
+  virtual CORBA::Short GetId();
+
+  // Return true if a hypothesis has parameters
+  virtual CORBA::Boolean HasParameters();
+
   // Set the variable parameter (a variable name or a parameter value); \a method is a name
   // of method setting this parameter.
   // This method must be called by the hypothesis creator just before calling hyp->method()
-  void SetVarParameter (const char* parameter, const char* method);
+  virtual void SetVarParameter (const char* parameter, const char* method);
 
   // Return the variable parameter used at Hypothesis Creation by the name of method
   // setting this parameter. The returned variable name is used at Hypothesis Edition.
-  char* GetVarParameter (const char* methodName);
+  virtual char* GetVarParameter (const char* methodName);
 
   // Store a hypothesis wrapping this not published one. This hyp, which has
   // no own parameters but is published, is used to store variables defining parameters
   // of this hypothesis. This method is to be called before setting parameters
   // of this hypothesis.
-  void SetHolderHypothesis(const SMESH::SMESH_Hypothesis_ptr hyp);
+  virtual void SetHolderHypothesis(const SMESH::SMESH_Hypothesis_ptr hyp);
 
   //Return true if hypothesis was published in study
   bool IsPublished();
@@ -94,7 +98,18 @@ public:
   // Persistence
   virtual char* SaveTo();
   virtual void  LoadFrom( const char* theStream );
-  virtual void  UpdateAsMeshesRestored(); // for hyps needing full data restored
+  virtual void  UpdateAsMeshesRestored(); // for hyps needing full study data restored
+
+
+  // Methods for copying mesh definition to other geometry
+
+  // Return geometry this hypothesis depends on. Return false if there is no geometry parameter
+  virtual bool getObjectsDependOn( std::vector< std::string > & entryArray,
+                                   std::vector< int >         & subIDArray ) const = 0;
+
+  // Set new geometry instead of that returned by getObjectsDependOn()
+  virtual bool setObjectsDependOn( std::vector< std::string > & entryArray,
+                                   std::vector< int >         & subIDArray ) = 0;
 
  protected:
 
@@ -116,10 +131,10 @@ public:
   // method used to convert variable parameters stored in an old study
   // into myMethod2VarParams. It should return a method name for an index of
   // variable parameters. Index is countered from zero
-  virtual std::string getMethodOfParameter(const int paramIndex, int nbVars) const { return ""; }
+  virtual std::string getMethodOfParameter(const int /*paramIndex*/, int /*nbVars*/) const { return ""; }
 
   // method intended to remove explicit treatment of Netgen hypotheses from SMESH_NoteBook
-  virtual int getParamIndex(const TCollection_AsciiString& method, int nbVars) const { return -1; }
+  virtual int getParamIndex(const TCollection_AsciiString& /*method*/, int /*nbVars*/) const { return -1; }
 };
 
 // ======================================================
@@ -130,11 +145,20 @@ class SMESH_I_EXPORT GenericHypothesisCreator_i
 public:
   // Create a hypothesis
   virtual SMESH_Hypothesis_i* Create(PortableServer::POA_ptr thePOA,
-                                     int                     theStudyId,
                                      ::SMESH_Gen*            theGenImpl) = 0;
-  // return the name of IDL module
+  virtual ~GenericHypothesisCreator_i() {}
+
+  // Return the name of IDL module
   virtual std::string GetModuleName() = 0;
-  virtual bool IsApplicable( const TopoDS_Shape &S, bool toCheckAll ) {return true;}
+
+  // Check if an algorithm is applicable to a shape
+  virtual bool IsApplicable( const TopoDS_Shape &S, bool /*toCheckAll*/, int algoDim )
+  {
+    return IsShapeOfDim( S, algoDim );
+  }
+
+  // Check if a shape includes sub-shapes of a given dimension
+  static bool IsShapeOfDim( const TopoDS_Shape &S, int dim );
 };
 
 //=============================================================================
@@ -148,10 +172,9 @@ template <class T> class HypothesisCreator_i: public GenericHypothesisCreator_i
 {
 public:
   virtual SMESH_Hypothesis_i* Create (PortableServer::POA_ptr thePOA,
-                                      int                     theStudyId,
                                       ::SMESH_Gen*            theGenImpl)
   {
-    return new T (thePOA, theStudyId, theGenImpl);
+    return new T (thePOA, theGenImpl);
   };
 };