verbose.m File Reference

This function displays messages depending on a message-id and/or a level. Aditionally you can set/reset the level-filer and add ore remove message-ids to the include and exclude lists. More...

Go to the source code of this file.

Functions
function r =	verbose (level, message, messageId)
	This function displays messages depending on a message-id and/or a level. Aditionally you can set/reset the level-filer and add ore remove message-ids to the include and exclude lists. More...

Detailed Description

This function displays messages depending on a message-id and/or a level. Aditionally you can set/reset the level-filer and add ore remove message-ids to the include and exclude lists.

Definition in file verbose.m.

Function Documentation

function r = verbose	(		level,
			message,
			messageId
	)

This function displays messages depending on a message-id and/or a level. Aditionally you can set/reset the level-filer and add ore remove message-ids to the include and exclude lists.

When messages will be displayed?

A Messages only will be diplayed only then if one of the following situation applies.

1. The message-id is listet in the include list
2. The messages level is lower or equal to the previously set and the message-id don't appear in the exclude list

Basic examples

To use the basic operation of verbose, only one or two arguments, the level and the message are necessary.

three ways to set the verbosity level e.g. to 10

1. > verbose(10);
2. > verbose(level,10);
3. > oldVerbLev = verbose(10); % change level to 10 > one_of_my_functions(); % ... some code ... > verbose(oldVerbLevel); % reset level to value before changed

get the current verbosity level

1. > level = verbose();
2. > level = verbose(level);

message output (verbosity level previously set to 10)

verbose(10, Hello World!); % message will be displayed verbose(11, Hello World!); % ... won't ... verbose(1, Hello World!); % ... will ...

Extended examples

The third argument, the message-id enables you to specify more precisely what should be displayed or not.

add/remove one or more message-ids to the include-/excludelist

verbose(addInclude, RB:ERROR); % add RB:ERROR to the include list verbose(addInclude, {RB:WARNING, RB:INFO}); % add RB:WARNING and RB:INFO ... verbose(include); % return includelist

% e.g. {RB:ERROR, RB:WARNING, RB:INFO}

verbose(addExclude, {RB:INFO,RB:UNKNOWN}); % add RB:INFO,RB:UNKNOWN to excludelist verbose(delInclude, {RB:ERROR,RB:INFO}); % remove RB:ERROR and RB:INFO verbose(exclude, {}); % clear exclude list

print messages

verbose(10); verbose(include, {RB:SURPRISE1}); verbose(exclude, {RB:SURPRISE2}); verbose(); verbose(1, Hello World!, RB:INFO); verbose(99, Hello What Happened, RB:SURPRISE1); % displayed, cause RB:SURPRISE1 is in includelist verbose(0, Surprise for you?); % no, you dont get it, its excluded

Parameters

level	level
message	message
messageId	messageId

Return values

r

r

Definition at line 17 of file verbose.m.