Merge from V6_main (04/10/2012)

[plugins/ghs3dprlplugin.git] / src / GHS3DPRLPlugin / GHS3DPRLPluginDC.py

diff --git a/src/GHS3DPRLPlugin/GHS3DPRLPluginDC.py b/src/GHS3DPRLPlugin/GHS3DPRLPluginDC.py
index b9bb2a34e04db8a31b4f4a1fc71d572462f99326..f72035d4fddaac59e7dc03d5f2ffc2054853996f 100644 (file)
--- a/src/GHS3DPRLPlugin/GHS3DPRLPluginDC.py
+++ b/src/GHS3DPRLPlugin/GHS3DPRLPluginDC.py
@@ -17,7 +17,12 @@
 # See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
 #
 
-from smesh import Mesh_Algorithm, AssureGeomPublished
+##
+# @package GHS3DPRLPluginDC
+# Python API for the GHS3DPRL meshing plug-in module.
+
+from smesh_algorithm import Mesh_Algorithm
+from smesh import AssureGeomPublished
 
 # import GHS3DPRLPlugin module if possible
 noGHS3DPRLPlugin = 0
@@ -33,47 +38,79 @@ None_Optimization, Light_Optimization, Medium_Optimization, Strong_Optimization
 # V4.1 (partialy redefines V3.1). Issue 0020574
 None_Optimization, Light_Optimization, Standard_Optimization, StandardPlus_Optimization, Strong_Optimization = 0,1,2,3,4
 
+#----------------------------
+# Mesh algo type identifiers
+#----------------------------
+
+## Algorithm type: GHS3DPRL tetrahedron 3D algorithm, see GHS3DPRL_Algorithm
 GHS3DPRL = "GHS3DPRL_3D"
 
+#----------------------------
+# Algorithms
+#----------------------------
 
 ## Tetrahedron GHS3DPRL 3D algorithm
-#  It is created by calling Mesh.Tetrahedron( GHS3DPRL, geom=0 )
 #
+#  It is created by calling smesh.Mesh.Tetrahedron( smesh.GHS3DPRL, geom=0 )
 class GHS3DPRL_Algorithm(Mesh_Algorithm):
 
+    ## name of the dynamic method in smesh.Mesh class
+    #  @internal
     meshMethod = "Tetrahedron"
+    ## type of algorithm used with helper function in smesh.Mesh class
+    #  @internal
     algoType   = GHS3DPRL
+    ## doc string of the method in smesh.Mesh class
+    #  @internal
+    docHelper  = "Creates tetrahedron 3D algorithm for volumes"
 
     ## Private constructor.
+    #  @param mesh parent mesh object algorithm is assigned to
+    #  @param geom geometry (shape/sub-shape) algorithm is assigned to;
+    #              if it is @c 0 (default), the algorithm is assigned to the main shape
     def __init__(self, mesh, geom=0):
         Mesh_Algorithm.__init__(self)
-        if none_optimization: print "Warning: GHS3DPRLPlugin module unavailable"
+        if noGHS3DPRLPlugin: print "Warning: GHS3DPRLPlugin module unavailable"
         self.Create(mesh, geom, self.algoType, "libGHS3DPRLEngine.so")
+        pass
 
     ## Defines hypothesis having several parameters
-    #
+    #  @return hypothesis object
     def Parameters(self):
         if not self.params:
             self.params = self.Hypothesis("GHS3DPRL_Parameters", [],
                                           "libGHS3DPRLEngine.so", UseExisting=0)
+            pass
         return self.params
 
     ## To keep working files or remove them. Log file remains in case of errors anyway.
+    #  @param toKeep "keep working files" flag value
     def SetKeepFiles(self, toKeep):
         self.Parameters().SetKeepFiles(toKeep)
+        pass
     
     ## Sets MED files name and path.
+    #  @param value MED file name
     def SetMEDName(self, value):
         self.Parameters().SetMEDName(value)
+        pass
 
     ## Sets the number of partition of the initial mesh
+    #  @param value number of partition value
     def SetNbPart(self, value):
         self.Parameters().SetNbPart(value)
+        pass
 
     ## When big mesh, start tepal in background
+    #  @param value "background mode" flag value
     def SetBackground(self, value):
         self.Parameters().SetBackground(value)
+        pass
 
     ## To mesh "holes" in a solid or not. Default is to mesh.
+    #  @param toMesh "mesh holes" flag value
     def SetToMeshHoles(self, toMesh):
         self.Parameters().SetToMeshHoles(toMesh)
+        pass
+    
+    pass # end of GHS3DPRL_Algorithm class