Salome HOME
Merge from BR_Dev_For_4_0 branch (from mergeto_BR_QT4_Dev_17Jan08 tag)
[modules/smesh.git] / src / SMESH_I / SMESH_PythonDump.hxx
index 6e65a3d4149dbc15a4c23c669641f0e3efb55da6..518e1be9220ca88703e8707d5aea712a20ac264f 100644 (file)
 class SMESH_Gen_i;
 class SMESH_MeshEditor_i;
 class TCollection_AsciiString;
+class Resource_DataMapOfAsciiStringAsciiString;
+
+// ===========================================================================================
+/*!
+ * \brief Tool converting SMESH engine calls into commands defined in smesh.py
+ *
+ * Implementation is in SMESH_2smeshpy.cxx
+ */
+// ===========================================================================================
+
+class SMESH_2smeshpy
+{
+public:
+  /*!
+   * \brief Convert a python script using commands of smesh.py
+   * \param theScript - Input script
+   * \param theEntry2AccessorMethod - The returning method names to access to
+   *        objects wrapped with python class
+   * \retval TCollection_AsciiString - Convertion result
+   */
+  static TCollection_AsciiString
+  ConvertScript(const TCollection_AsciiString& theScript,
+                Resource_DataMapOfAsciiStringAsciiString& theEntry2AccessorMethod);
+
+  /*!
+   * \brief Return the name of the python file wrapping IDL API
+    * \retval TCollection_AsciiString - The file name
+   */
+  static char* SmeshpyName() { return "smesh"; }
+  static char* GenName() { return "smesh.smesh"; }
+};
 
 namespace SMESH
 {
@@ -39,6 +70,12 @@ namespace SMESH
   class Filter_i;
   class Functor_i;
 
+// ===========================================================================================
+/*!
+ * \brief Utility helping in storing SMESH engine calls as python commands
+ */
+// ===========================================================================================
+
   class SMESH_I_EXPORT TPythonDump
   {
     std::ostringstream myStream;
@@ -144,5 +181,4 @@ namespace SMESH
   };
 }
 
-
 #endif