doc/salome/gui/GEOM/input/check_shape.doc

   1 /*!
   2
   3 \page check_shape_page Check Shape
   4
   5 \n This operation checks the topology of the selected geometrical object and returns
   6 True if it is valid.
   7
   8 \image html measures9.png
   9
  10 In this dialog:
  11
  12 - \b Object - the checked object. \b Selection button allows picking it in the viewer or in the object browser.
  13 - <b>Check also geometry</b> option allows testing the geometry of the object as well.
  14 - \b Errors list informs of possible errors.
  15 - <b>Incriminated Sub-shapes</b> field outputs the list of sub-shapes that cause problem. It is possible to select them in the list and publish in the study for further analysis by clicking \b Apply or <b>Apply and Close</b> button.
  16
  17 \n <b>TUI Commands:</b>
  18
  19 <UL>
  20
  21 <LI>
  22 <em>geompy.CheckShape(theShape, theIsCheckGeom = 0, theReturnStatus = 0),</em> \n
  23 where \n
  24 \em theShape is the shape checked for validity. \n
  25 \em theIsCheckGeom is the flag that tells if geometry should be checked also.\n
  26 \em theReturnStatus is the flag that can have the following values:
  27 <UL>
  28 <LI>0 - if theShape is invalid, a description of problem is printed.
  29 \em IsValid status is returned.</LI>
  30 <LI>1 - \em IsValid status and the description of problem are returned.</LI>
  31 <LI>2 - \em IsValid status and the list of error data are returned.</LI>
  32 </UL>
  33 </LI>
  34
  35 <LI>
  36 <em>geompy.PrintShapeErrors(self, theShape, theShapeErrors, theReturnStatus = 0),</em> \n
  37 where \n
  38 \em theShape is the shape checked for validity. \n
  39 \em theShapeErrors are the shape errors obtained by CheckShape. \n
  40 \em theReturnStatus is the flag that can have the following values:
  41 <UL>
  42 <LI>0 - the problem description is printed and \em IsValid status is returned.</LI>
  43 <LI>1 - the problem description is returned.</LI>
  44 </UL>
  45 </LI>
  46 </UL>
  47
  48 See also a \ref tui_check_shape_page "TUI example".
  49
  50
  51
  52 */