GIRAFFE Pipeline Reference Manual

Error Reporting Utilities

Functions

void gi_error (const cxchar *format,...)
 Log an error message.
void gi_critical (const cxchar *format,...)
 Log a "critical" warning.
void gi_warning (const cxchar *format,...)
 Log a warning.
void gi_message (const cxchar *format,...)
 Log a normal message.

Detailed Description

TBD


Function Documentation

void gi_critical ( const cxchar *  format,
  ... 
)

Log a "critical" warning.

Parameters:
format The format string.
... Arguments to be inserted into the format string.
Returns:
Nothing.

This is a convenience function to log a message with level CX_LOG_LEVEL_CRITICAL, as specified by the format string format and the following list of arguments, via the installed log handler.

It is up to the application to decide which warnings are critical and which are not. To cause a termination of the application on critical warnings you may call cx_log_set_always_fatal().

See also:
gi_warning

Definition at line 99 of file gimessages.c.

void gi_error ( const cxchar *  format,
  ... 
)

Log an error message.

Parameters:
format The format string.
... Arguments to be inserted into the format string.
Returns:
Nothing.

This is a convenience function to log an error message specified by the format string format and the following list of arguments via the installed log handler.

Error messages are always considered fatal, i.e. the application is immediately terminated by a call to abort() causing a core dump. Do not use this function for expected (recoverable) errors. This function should be used to indicate a bug (assertion failure) in the application.

See also:
gi_critical

Definition at line 67 of file gimessages.c.

void gi_message ( const cxchar *  format,
  ... 
)

Log a normal message.

Parameters:
format The format string.
... Arguments to be inserted into the format string.
Returns:
Nothing.

This is a convenience function to log an ordinary message, as specified by the format string format and the following list of arguments, via the installed log handler.

Definition at line 154 of file gimessages.c.

Referenced by giraffe_extract_spectra(), and giraffe_slitgeometry_print().

void gi_warning ( const cxchar *  format,
  ... 
)

Log a warning.

Parameters:
format The format string.
... Arguments to be inserted into the format string.
Returns:
Nothing.

This is a convenience function to log a warning message, as specified by the format string format and the following list of arguments, via the installed log handler.

See also:
gi_critical

Definition at line 127 of file gimessages.c.

Referenced by giraffe_calibrate_flux(), giraffe_extract_spectra(), giraffe_get_mode(), and giraffe_parse_spectrum_selection().


This file is part of the GIRAFFE Pipeline Reference Manual 2.8.8.
Documentation copyright © 2002-2006 European Southern Observatory.
Generated on Fri Mar 4 10:50:29 2011 by doxygen 1.6.3 written by Dimitri van Heesch, © 1997-2004