Salome HOME
0022364: EDF SMESH: Create Mesh dialog box improvement: hide inapplicable algorithms...
[modules/smesh.git] / src / SMESH_I / SMESH_Gen_i.hxx
index a72c466f31c9f97daff0038896330d1ced30e95f..3405a83750840b9a68b6f6f72bec51f53d7b5671 100644 (file)
@@ -1,4 +1,4 @@
-// Copyright (C) 2007-2012  CEA/DEN, EDF R&D, OPEN CASCADE
+// Copyright (C) 2007-2014  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
@@ -6,7 +6,7 @@
 // This library is free software; you can redistribute it and/or
 // modify it under the terms of the GNU Lesser General Public
 // License as published by the Free Software Foundation; either
-// version 2.1 of the License.
+// version 2.1 of the License, or (at your option) any later version.
 //
 // This library is distributed in the hope that it will be useful,
 // but WITHOUT ANY WARRANTY; without even the implied warranty of
 #include CORBA_CLIENT_HEADER(SALOMEDS)
 #include CORBA_CLIENT_HEADER(SALOMEDS_Attributes)
 
+#include "SMESH_Gen.hxx"
 #include "SMESH_Mesh_i.hxx"
 #include "SMESH_Hypothesis_i.hxx"
-#include "SALOME_Component_i.hxx"
-#include "SALOME_NamingService.hxx"
 
-#include "SMESH_Gen.hxx"
-#include "GEOM_Client.hxx"
+#include <SALOME_Component_i.hxx>
+#include <SALOME_NamingService.hxx>
+#include <Utils_CorbaException.hxx>
+
+#include <GEOM_Client.hxx>
 
 #include <TCollection_AsciiString.hxx>
 #include <Resource_DataMapOfAsciiStringAsciiString.hxx>
@@ -146,7 +148,7 @@ public:
   // Get SALOME_LifeCycleCORBA object
   static SALOME_LifeCycleCORBA* GetLCC();
   // Retrieve and get GEOM engine reference
-  static GEOM::GEOM_Gen_ptr GetGeomEngine();
+  static GEOM::GEOM_Gen_var GetGeomEngine();
   // Get object of the CORBA reference
   static PortableServer::ServantBase_var GetServant( CORBA::Object_ptr theObject );
   // Get CORBA object corresponding to the SALOMEDS::SObject
@@ -238,7 +240,7 @@ public:
   SMESH::SMESH_Mesh_ptr CreateEmptyMesh()
     throw ( SALOME::SALOME_Exception );
 
-  //  Create mesh(es) and import data from UNV fileter
+  //  Create a mesh and import data from an UNV file
   SMESH::SMESH_Mesh_ptr CreateMeshesFromUNV( const char* theFileName )
     throw ( SALOME::SALOME_Exception );
 
@@ -252,7 +254,7 @@ public:
                                            SMESH::DriverMED_ReadStatus& theStatus )
     throw ( SALOME::SALOME_Exception );
 
-  //  Create mesh(es) and import data from STL file
+  //  Create a mesh and import data from a STL file
   SMESH::SMESH_Mesh_ptr CreateMeshesFromSTL( const char* theFileName )
     throw ( SALOME::SALOME_Exception );
 
@@ -261,6 +263,12 @@ public:
                                            SMESH::DriverMED_ReadStatus& theStatus )
     throw ( SALOME::SALOME_Exception );
 
+  //  Create a mesh and import data from a GMF file
+  SMESH::SMESH_Mesh_ptr CreateMeshesFromGMF( const char*             theFileName,
+                                             CORBA::Boolean          theMakeRequiredGroups,
+                                             SMESH::ComputeError_out theError)
+    throw ( SALOME::SALOME_Exception );
+
   // Copy a part of mesh
   SMESH::SMESH_Mesh_ptr CopyMesh(SMESH::SMESH_IDSource_ptr meshPart,
                                  const char*               meshName,
@@ -318,6 +326,12 @@ public:
                                                  CORBA::Short          theSubShapeID )
     throw ( SALOME::SALOME_Exception );
 
+  // Create groups of elements preventing computation of a sub-shape
+  SMESH::ListOfGroups* MakeGroupsOfBadInputElements( SMESH::SMESH_Mesh_ptr theMesh,
+                                                     CORBA::Short          theSubShapeID,
+                                                     const char*           theGroupName)
+    throw ( SALOME::SALOME_Exception );
+
   // Get sub-shapes unique ID's list
   SMESH::long_array* GetSubShapesId( GEOM::GEOM_Object_ptr      theMainShapeObject,
                                      const SMESH::object_array& theListOfSubShape )
@@ -425,7 +439,7 @@ public:
   // Copy-paste methods - returns true if object can be copied to the clipboard
   CORBA::Boolean CanCopy( SALOMEDS::SObject_ptr theObject ) { return false; }
   // Copy-paste methods - copy object to the clipboard
-  SALOMEDS::TMPFile* CopyFrom( SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID ) { return false; }
+  SALOMEDS::TMPFile* CopyFrom( SALOMEDS::SObject_ptr theObject, CORBA::Long& theObjectID ) { return NULL; }
   // Copy-paste methods - returns true if object can be pasted from the clipboard
   CORBA::Boolean CanPaste( const char* theComponentName, CORBA::Long theObjectID ) { return false; }
   // Copy-paste methods - paste object from the clipboard
@@ -436,6 +450,12 @@ public:
     return aResultSO._retn();
   }
 
+  // ============
+  // Version information
+  // ============
+
+  virtual char* getVersion();
+
   // ============
   // Dump python
   // ============
@@ -458,12 +478,18 @@ public:
                                            bool isMultiFile,
                                            bool isHistoricalDump,
                                            bool& aValidScript,
-                                           const TCollection_AsciiString& theSavedTrace);
+                                           TCollection_AsciiString& theSavedTrace);
 
   TCollection_AsciiString GetNewPythonLines (int theStudyID);
 
   void CleanPythonTrace (int theStudyID);
 
+  // SIMAN-related functions (check out/check in) : import data to study
+  virtual Engines::ListOfIdentifiers* importData(CORBA::Long studyId,
+                                                 Engines::DataContainer_ptr data,
+                                                 const Engines::ListOfOptions& options);
+  // SIMAN-related functions (check out/check in) : get modified data
+  virtual Engines::ListOfData* getModifiedData(CORBA::Long studyId);
 
   // *****************************************
   // Internal methods
@@ -557,17 +583,32 @@ public:
    */
   SALOMEDS::SObject_ptr GetAlgoSO(const ::SMESH_Algo* algo);
 
-  void UpdateParameters(/*CORBA::Object_ptr theObject,*/ const char* theParameters);
+  void UpdateParameters(CORBA::Object_ptr theObject, const char* theParameters);
   char* GetParameters(CORBA::Object_ptr theObject);
-  char* ParseParameters(const char* theParameters);
+  //char* ParseParameters(const char* theParameters);
+  const std::vector< int >&         GetLastParamIndices() const { return myLastParamIndex; }
   const std::vector< std::string >& GetLastParameters() const { return myLastParameters; }
+  const std::string &               GetLastObjEntry() const { return myLastObj; }
+  std::vector< std::string >        GetAllParameters(const std::string& theObjectEntry) const;
+
+  // Move objects to the specified position
+  void Move( const SMESH::sobject_list& what,
+             SALOMEDS::SObject_ptr where,
+             CORBA::Long row );
+  CORBA::Boolean IsApplicable ( const char*           theAlgoType,
+                                const char*           theLibName,
+                                GEOM::GEOM_Object_ptr theShapeObject,
+                                CORBA::Boolean        toCheckAll);
 
 private:
+  // Get hypothesis creator
+  GenericHypothesisCreator_i* getHypothesisCreator( const char*  theHypName,
+                                                    const char*  theLibName,
+                                                    std::string& thePlatformLibName)
+  throw ( SALOME::SALOME_Exception );
   // Create hypothesis of given type
   SMESH::SMESH_Hypothesis_ptr createHypothesis( const char* theHypName,
-                                                const char* theLibName)
-    throw ( SALOME::SALOME_Exception );
-
+                                                const char* theLibName);
   // Create empty mesh on shape
   SMESH::SMESH_Mesh_ptr createMesh()
     throw ( SALOME::SALOME_Exception );
@@ -606,7 +647,11 @@ private:
   // Dump Python: trace of API methods calls
   std::map < int, Handle(TColStd_HSequenceOfAsciiString) > myPythonScripts;
   bool                                                     myIsHistoricalPythonDump;
+  std::vector< int >                                       myLastParamIndex;
   std::vector< std::string >                               myLastParameters;
+  std::string                                              myLastObj;
+  int                                                      myImportedStudyId;      // SIMAN: identifier of the imported in importData study to keep no-modifiection flag for getModifiedData method
+  int                                                      myImportedStudyChanged; // SIMAN: flag that indicates that the imported study has been changed (by creation of the additional mesh)
 };
 
 
@@ -618,6 +663,15 @@ namespace SMESH
   {
     return dynamic_cast<T>(SMESH_Gen_i::GetServant(theArg).in());
   }
+
+  /*!
+   * \brief Function used in SMESH_CATCH to convert a caught exception to
+   * SALOME::SALOME_Exception
+   */
+  inline void throwCorbaException(const char* excText)
+  {
+    THROW_SALOME_CORBA_EXCEPTION( excText, SALOME::INTERNAL_ERROR );
+  }
 }