rbmatlab 0.10.01
Functions
general/verbosity/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.

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); change level to 10 ... some code ... 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) message will be displayed ... won't ... ... 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 add RB:ERROR to the include list add RB:WARNING and RB:INFO ... return includelist e.g. {RB:ERROR, RB:WARNING, RB:INFO} add RB:INFO,RB:UNKNOWN to excludelist remove RB:ERROR and RB:INFO clear exclude list

print messages > verbose(10); > verbose(include, {RB:SURPRISE1}); > verbose(exclude, {RB:SURPRISE2}); > verbose(); > verbose(1, Hello World!, RB:INFO); displayed, cause RB:SURPRISE1 is in includelist no, you dont get it, its excluded

Parameters:
levellevel
messagemessage
messageIdmessageId
Return values:
rr

Definition at line 1 of file verbose.m.

 All Classes Namespaces Files Functions Variables