发布警告(GNU Octave(版本9.4.0))

12.2.1报警告¶

可以使用从任何代码报警告warning作用在其最简单的形式中warning函数将描述警告作为其输入参数。例如,以下代码控制变量a是非负的,如果不是,则报警告并设置a为零。

a = -1;
if (a < 0)
  warning ("'a' must be non-negative.  Setting 'a' to zero.");
  a = 0;
endif
     -| 'a' must be non-negative.  Setting 'a' to zero.

从于警告对正在运行的程序来说并不是致命的,因此不可能使用try语句或类似的东西。但是,可以使用lastwarn作用

也可以将标识字符串赋值给警告。如果警告具有这样的ID,用户可以启用和禁用此警告,如下一节所述。要为警告赋值ID,只需调用warning有两个字符串参数,其中第一个是标识字符串,第二个是实际警告。请注意,警告ID的格式为"NAMESPACE:WARNING-NAME".命名空间"Octave"用于Octave自己的警告。任何其他可用作用户自己警告的命名空间的字符串。

: warning (template, …) ¶

: warning (id, template, …) ¶

: warning ("on", id) ¶

: warning ("off", id) ¶

: warning ("error", id) ¶

: warning ("query", id) ¶

: warning (state, id, "local") ¶

: warning (warning_struct) ¶

: warning_struct = warning (…) ¶

: warning (state, mode) ¶

显示警告消息或控制Octave的警告系统的行为。

第一个呼叫表单使用模板template和可选的附加参数,以在上显示消息stderr流动邮件的格式使用与相同的规则printf函数族(详见格式化输出)并以字符串'为前缀warning: ’ 。当您想通知用户异常情况时,您应该使用此函数,但仅当您的程序启动时才有意义。例如:

warning ("foo: maybe something wrong here");

如果警告消息没有以换行符结束,Octave将打印导致警告的所有函数调用的回溯。如果警告消息确实以换行符结尾,Octave将在将控制权返回到顶级时抑制回溯消息。有关更多详细信息和示例,详见error.

可选的警告标识符id允许用户启用或禁用此标识符符号的警告。消息标识符是表单的字符串"NAMESPACE:WARNING-NAME"。Octave自己的警告使用"Octave"命名空间(详见warning_ids). 例如:

warning ("MyNameSpace:check-something",
         "foo: maybe something wrong here");

第二个调用表单用于更改和/或查询警告的状态。第一个输入参数必须是字符串state("on","off", "error"或"query")后跟optionalwarning标识符id或"all"默认

可选输出参数warning_struct是具有字段的结构体或结构体数组"state"和"identifier"这个state参数可能具有以下值:

"on"|"off":: 启用或禁用从标识的警告的显示id并可选择返回其前一个状态stout.

结构体或结构体数组warning_struct,包含字段"state"和"identifier",可以作为实现等效结果的输入。以下示例显示了如何临时禁用唤醒,然后恢复其原始状态:

如果最后一个参数"local"则警告状态将被暂时困扰,直到当前函数结束。对本地设置的警告状态的更改会影响当前函数以及从当前范围扩展的所有函数。从当前函数返回时,将恢复前一个警告状态。这个"local"如果在顶级工作区中使用,则忽略参数。

没有输入参数warning ()相当于warning ("query", "all")除了在没有输出的情况下,警告的状态显示在上stderr.

支持说明:为了与兼容MATLAB,中的转义序列template(例如。,"\n"=>换行符)被处理,而不考虑是否template已经用单引号定义,只要有两个或多个输入参数即可。要禁用转义序列扩展,请在序列之前使用第二个反斜杠(例如。,"\\n")或使用regexptranslate作用