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

   1 /*!
   2
   3 \page check_shape_page Check Shape
   4
   5 \n Checks the topology of the selected geometrical object and returns
   6 True if it is valid. Check also geometry checkbox allows to test the
   7 geometry as well.
   8
   9 \n <b>Result:</b> Boolean; highlight in the viewer.
  10 \n <b>TUI Commands:</b>
  11 <UL>
  12 <LI>
  13 <em>geompy.CheckShape(theShape, theIsCheckGeom = 0, theReturnStatus = 0),</em> \n
  14 where \n
  15 \em theShape is the shape checked for validity. \n
  16 \em theIsCheckGeom is the flag that tells if geometry should be checked also.\n
  17 \em theReturnStatus is the flag that can have the following values:
  18 <UL>
  19 <LI>0 - Means that if theShape is invalid, a description of problem is printed.
  20 IsValid status is returned.</LI>
  21 <LI>1 - Means that IsValid status and the description of problem are returned.</LI>
  22 <LI>2 - Means that IsValid status and the list of error data are returned.</LI>
  23 </UL>
  24 </LI>
  25 <LI>
  26 <em>geompy.PrintShapeErrors(self, theShape, theShapeErrors, theReturnStatus = 0),</em> \n
  27 where \n
  28 \em theShape Shape that was checked. \n
  29 \em theShapeErrors the shape errors obtained by CheckShape. \n
  30 \em theReturnStatus is the flag that can have the following values:
  31 <UL>
  32 <LI>0 - Means that a description of problem is printed.
  33 IsValid status is returned.</LI>
  34 <LI>1 - Means that the description of problem is returned.</LI>
  35 </UL>
  36 </LI>
  37 </UL>
  38 See also a \ref tui_check_shape_page "TUI example".
  39
  40 \image html measures9.png
  41
  42
  43 */