set_check ( : : Check : )

Activating and deactivating of HALCON control modes.

With the help of the operator set_check different control modes of the HALCON system can be activated or deactivated. If a certain control mode is activated, parameters etc. will be checked at runtime. Whenever an inconsistency is hereby detected, the program will be interrupted by an exception.

It is recommendable to activate the control modes during the development of a program and to deactivate them only after a successfully concluded testrun. For if the control mode is deactivated and an error occurs, the system may react in an unpredictable way.

The HALCON system provides various possible control modes which can be activated and deactivated independently. By calling the operator set_check with the name (Check) of the desired control mode, this control mode is activated; the control mode is deactivated by passing its name prefixed with a tilde (~, z.B. '~data').

Available control modes:

    'color'
          If this control mode is activated, only colors may be used which
          are supported by the display for the currently active window.
          Otherwise an error message is displayed.
          In case of the deactivated control mode and non existent colors,
          the nearest color is used (see also set_color,
          set_gray,set_rgb).

    'text'
          If this control mode is activated, it will check the coordinates
          during the setting of the text cursor as well as during the display
          of strings (write_string) to the effect whether
          a part of a sign would lie outside the windowframe (a fact which
          is not forbidden in principle by the system).
          If the control mode is deactivated, the text will be clipped at
          the windowframe.

    'data'
          (For program development)
          Checks the consistency of image objects (regions and grayvalue
          components).

    'interface'
          If this control mode is activated, the interface between the host
          language and the HALCON procedures will be checked at runtime
          (e.g.\ typifying and counting of the values).

    'database'
          This is a consistency check of the database (e.g.\ checks whether
          an object which shall be canceled does indeed exist or not.)

    'give_error'
          Determines whether errors shall trigger exceptions or
          not. If this control mode is deactivated, the application
          program must provide a suitable error treatment
          itself. Please note that errors which are not reported
          usually lead to undefined output parameters which may
          cause an unpredictable reaction of the program.
          Details about how to handle exceptions in the different
          HALCON language interfaces can be found in the HALCON
          Programmer's Guide and the HDevelop User's Guide.

    'father'
          If this control mode is activated when calling the operators
          open_window or open_textwindow, HALCON\ allows only
          the usage of the number of another HALCON window as the father
          window of the new window; otherwise it allows also the usage of
          IDs of operating system windows as the father window. This control
          mode ist only relevant for windows of type 'X-Window' and 
          'WIN32-Window'.

    'region'
          (For program development)
          Checks the consistency of the chords (this may lead to a notable
          speed reduction of routines).

    'clear'
          Normally, if a list of objects shall be removed by using
          clear_obj, an exception will be raised, in case individual
          objects do not or no longer exist. If the 'clear' mode is
          activated, such objects will be ignored.

    'all'
          Activates all control modes.

    'none'
          Deactivates all control modes.

    'default'
          Default settings: ['give_error','database']


Parameters

Check (input_control)
string(-array) -> string
Desired control mode.
Default value: 'default'
List of values: 'color', 'text', 'database', 'data', 'interface', 'give_error', 'father', 'region', 'clear', 'all', 'none', 'default'


Result

The operator set_check returns the value 2 (H_MSG_TRUE), if the parameters are correct. Otherwise an exception will be raised.


Parallelization Information

set_check is reentrant and processed without parallelization.


See also

get_check, set_color, set_rgb, set_hsi, write_string


Module

Foundation



Copyright © 1996-2008 MVTec Software GmbH