Last modified: December 2013

URL: https://cxc.cfa.harvard.edu/chips/ahelp/get_errors.html
Jump to: Description · Examples · Bugs · See Also


AHELP for CIAO 4.11 ChIPS v1

get_errors

Context: errors

Synopsis

Retrieves errors from the ChIPS server error list.

Syntax

get_errors()

Description

The get_errors command retrieves a text string of any warning or error messages from the ChIPS server. This command is part of the advanced ChIPS module; refer to "ahelp chips" for information. To load the module:

from pychips.advanced import *

Generally, errors and warnings detected by the server are put into a buffer which the user may access. The buffer is cleared automatically at the start of most commands, so that the buffer only contains errors and warnings related to the executed command. The buffer may also be cleared with the clear_errors command.

The amount of information returned by get_errors depends on the error verbosity setting. Changing the error verbosity setting does not clear out the error buffer, so the setting can be adjusted to modify the detail returned by get_errors. For more information on the verbosity levels, refer to "ahelp set_error_verbosity".


Examples

Example 1

chips> add_contour([1,4,3,2], 2, 2)
chips> add_contour([2,4,1,0], 2, 2)
chips> set_contour('all', {'color': 'grene'})
chips ERROR: The color 'grene' is unknown or not supported
chips> get_errors()

Create two contour and attempt to make them both green. get_errors is then called to retrieve the error buffer.

Example 2

chips> set_error_verbosity(3)
chips> get_errors()

Set the error verbosity level to 3 to print detailed information, then retrieve the error buffer.


Bugs

See the bugs pages on the ChIPS website for an up-to-date listing of known bugs.

See Also

errors
clear_errors, get_error_count, get_error_types, get_error_verbosity, set_error_verbosity