mlreportgen.dom.ProgressMessage クラス

名前空間: mlreportgen.dom

進行状況メッセージ

このページをすべて展開する

説明

指定のテキストを使い、指定のソース オブジェクトから発する進行状況メッセージを作成します。

mlreportgen.dom.ProgressMessage クラスは handle クラスです。

作成

説明

progressMsgObj = ProgressMessage(text,sourceDOMObject) は、指定のテキストを使い、指定のソース オブジェクトから発する進行状況メッセージを作成します。

例

入力引数

すべて展開する

メッセージに表示するテキスト。文字ベクトルまたは string スカラーとして指定します。

メッセージを発する DOM オブジェクト。

プロパティ

すべて展開する

メッセージの発生元である DOM オブジェクト。

属性:

GetAccess
public
SetAccess
なし
Transient
true

メッセージ テキスト。文字ベクトルまたは string スカラーとして指定します。

属性:

GetAccess
public
SetAccess
public
Transient
true
NonCopyable
true

データ型: char | string

タグ。文字ベクトルまたは string スカラーとして指定します。DOM API は、このオブジェクトを作成するときに、セッション固有タグを生成します。生成されるタグの形式は CLASS:ID という形式です。ここで、CLASS はオブジェクト クラスです。ID はオブジェクトの Id プロパティの値です。この値を使用すると、ドキュメントの生成中に問題が発生した箇所を容易に特定できるようになります。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

オブジェクト識別子。文字ベクトルまたは string スカラーとして指定します。DOM API は、ドキュメント要素オブジェクトの作成時にセッション固有識別子を生成します。

属性:

GetAccess
public
SetAccess
public
NonCopyable
true

データ型: char | string

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

レポート ドキュメントを作成します。 

import mlreportgen.dom.*;
d = Document('test','html');

メッセージ ディスパッチャーを作成します。 

dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,'Message', ...
      @(src, evtdata) disp(evtdata.Message.formatAsText));

メッセージをディスパッチします。 

open(d);
dom.Document:195 opening
dom.Document:195 parsing template "/mathworks/devel/bat/filer/batfs2566-0/Bdoc25b.2988451/build/runnable/matlab/toolbox/shared/mlreportgen/dom/resources/templates/html/default.htmtx"
dom.Document:195 appended dom.TemplateText:213
dom.Document:195 appended dom.TemplateText:216
dom.Document:195 appended dom.TemplateText:219
dom.Document:195 moved to hole "#start#"

dispatch(dispatcher,ProgressMessage('starting chapter',d));
dom.Document:195 starting chapter

レポート コンテンツを追加します。 

p = Paragraph('Chapter ');
p.Tag = 'chapter title';
p.Style = { CounterInc('chapter'),...
    CounterReset('table'),WhiteSpace('pre') };
append(p, AutoNumber('chapter'));
append(d,p);
dom.Document:195 appended chapter title

レポートを実行し、リスナーを削除します。 

close(d);
dom.Document:195 appended dom.TemplateText:234
dom.Document:195 moved to hole "#end#"
dom.Document:195 closed

rptview('test','html');

MATLAB® セッション中にメッセージ オブジェクトについて重複して報告されないように、リスナーを削除します。 

delete(l);

バージョン履歴

R2014b で導入

参考

トピック