SINFONI Pipeline Reference Manual
2.6.0
|
Macros | |
#define | sinfo_msg_error(...) cpl_msg_error(cpl_func, __VA_ARGS__) |
Print an error message. More... | |
#define | sinfo_msg_progress(i, iter,...) cpl_msg_progress(cpl_func, (i), (iter), __VA_ARGS__) |
Print a progress message. More... | |
#define | sinfo_msg_warning(...) sinfo_msg_warning_macro(cpl_func, __VA_ARGS__) |
Print an warning message. More... | |
#define | sinfo_msg_debug(...) cpl_msg_debug(cpl_func, __VA_ARGS__) |
Print a debug message. More... | |
#define | sinfo_msg_low(...) |
Print a message on a lower message level. More... | |
Functions | |
void | sinfo_msg_init (int outlevel, const char *dom) |
Initialize messaging. More... | |
void | sinfo_msg_set_level (int olevel) |
Set output level. More... | |
const char * | sinfo_msg_get_domain (void) |
Get current message domain. More... | |
void | sinfo_msg_set_domain (const char *d) |
Set message domain. More... | |
void | sinfo_msg_macro (const char *fct, const char *format,...) |
Print a message on 'info' or 'debug' level. More... | |
void | sinfo_msg_warning_macro (const char *fct, const char *format,...) |
Print a warning message. More... | |
int | sinfo_msg_get_warnings (void) |
Get number of warnings printed so far. More... | |
void | sinfo_msg_add_warnings (int n) |
Accumulate warnings. More... | |
void | sinfo_msg_softer_macro (const char *fct) |
Decrease message level. More... | |
void | sinfo_msg_louder_macro (const char *fct) |
Increase message level. More... | |
CPL's info message level is expanded to a set of relative message level. The functions sinfo_msg_louder() and sinfo_msg_softer() are used to turn up/down the message level (instead of setting the verbosity to an absolute level) These two functions should be used consistently, so that the level is always the same on function exit as on function entry.
These functions never fail, but print warnings if called inconsistently.
#define sinfo_msg_debug | ( | ... | ) | cpl_msg_debug(cpl_func, __VA_ARGS__) |
Print a debug message.
... | Message to print |
This function is used instead of cpl_msg_debug()
, and saves the user from typing the calling function name.
Definition at line 103 of file sinfo_msg.h.
#define sinfo_msg_error | ( | ... | ) | cpl_msg_error(cpl_func, __VA_ARGS__) |
Print an error message.
... | Message to print |
This function is used instead of cpl_msg_error()
, and saves the user from typing the calling function name.
Definition at line 69 of file sinfo_msg.h.
#define sinfo_msg_low | ( | ... | ) |
Print a message on a lower message level.
... | Message to print |
Definition at line 111 of file sinfo_msg.h.
#define sinfo_msg_progress | ( | i, | |
iter, | |||
... | |||
) | cpl_msg_progress(cpl_func, (i), (iter), __VA_ARGS__) |
Print a progress message.
i | See cpl_msg_progress() |
iter | See cpl_msg_progress() |
... | Message to print |
This function is used instead of cpl_msg_progress()
, and saves the user from typing the calling function name.
Definition at line 82 of file sinfo_msg.h.
#define sinfo_msg_warning | ( | ... | ) | sinfo_msg_warning_macro(cpl_func, __VA_ARGS__) |
Print an warning message.
... | Message to print |
This function is used instead of cpl_msg_warning()
, and saves the user from typing the calling function name.
Definition at line 93 of file sinfo_msg.h.
Referenced by sinfo_msg_louder_macro().
void sinfo_msg_add_warnings | ( | int | n | ) |
Accumulate warnings.
n | Number of warnings to add |
The (internal) number of warnings (returned by sinfo_msg_get_warnings()
) is increased by n, but without actually printing any warnings.
Definition at line 267 of file sinfo_msg.c.
const char* sinfo_msg_get_domain | ( | void | ) |
Get current message domain.
sinfo_msg_init()
or sinfo_msg_set_domain()
. Definition at line 311 of file sinfo_msg.c.
int sinfo_msg_get_warnings | ( | void | ) |
Get number of warnings printed so far.
Definition at line 251 of file sinfo_msg.c.
void sinfo_msg_init | ( | int | olevel, |
const char * | dom | ||
) |
Initialize messaging.
olevel | The output level |
dom | The message domain |
Only messages at levels 0 (most important) to outlevel are printed as 'info'. Messages at levels above outlevel are printed as 'debug'.
Therefore, set outlevel = 0 to print fewest messages. Increase outlevel to increase verbosity.
To print all messages as 'info' set outlevel to the special value -1 (which has the effect of infinity).
Definition at line 102 of file sinfo_msg.c.
References sinfo_msg_set_domain().
void sinfo_msg_louder_macro | ( | const char * | fctid | ) |
Increase message level.
fctid | Identity of calling function |
Don't call this function directly, use sinfo_msg_louder()
.
Definition at line 177 of file sinfo_msg.c.
References sinfo_msg_warning.
void sinfo_msg_macro | ( | const char * | fct, |
const char * | format, | ||
... | |||
) |
Print a message on 'info' or 'debug' level.
fct | Identity of calling function |
format | A printf()-like format string |
Don't call this function directly, use sinfo_msg()
.
If the current level (which might be equal to the current depth of the function call-tree) is less than the output level, the message printed on the 'info' level, otherwise it is printed on the 'debug' level.
Definition at line 220 of file sinfo_msg.c.
void sinfo_msg_set_domain | ( | const char * | d | ) |
Set message domain.
d | The new message domain |
Definition at line 323 of file sinfo_msg.c.
Referenced by sinfo_msg_init().
void sinfo_msg_set_level | ( | int | olevel | ) |
Set output level.
olevel | The output level |
See sinfo_msg_init()
.
Definition at line 139 of file sinfo_msg.c.
void sinfo_msg_softer_macro | ( | const char * | fctid | ) |
Decrease message level.
fctid | Identity of calling function |
Don't call this function directly, use sinfo_msg_softer()
.
Definition at line 154 of file sinfo_msg.c.
void sinfo_msg_warning_macro | ( | const char * | fct, |
const char * | format, | ||
... | |||
) |
Print a warning message.
fct | Identity of calling function |
format | A printf()-like format string |
Don't call this function directly, use sinfo_msg_warning()
.
This function is used instead of cpl_msg_warning()
, and saves the user from typing the calling function name.
Additionally, record is kept on the total number of warnings printed (see sinfo_msg_get_warnings()
).
Definition at line 288 of file sinfo_msg.c.