mlreportgen.dom.MessageDispatcher クラス

名前空間: mlreportgen.dom

DOM メッセージ ディスパッチャー

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

説明

ドキュメント生成ステータス メッセージ用のディスパッチャー。

メモ

メッセージ ディスパッチャーを作成すると、DOM API は現在の MATLAB® セッションが終了するまでディスパッチャーを保持します。MATLAB セッション中にメッセージ オブジェクトの報告が重複するのを避けるには、メッセージ イベント リスナーを削除します。

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

プロパティ

すべて展開する

ディスパッチャーがディスパッチするメッセージの種類を決定するメッセージ フィルター。文字ベクトルまたは string スカラーとして指定します。フィルターのプロパティを設定することで、ディスパッチされるメッセージの種類を制御できます。

属性:

GetAccess
public
SetAccess
protected
NonCopyable
true
Transient
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.*;
doctype = "html";
d = Document("test",doctype);
d.Tag = "My report";
          dispatcher = MessageDispatcher.getTheDispatcher;
l = addlistener(dispatcher,"Message", ...
    @(src,evtdata) disp(evtdata.Message.formatAsText));
     
open(d);
dispatch(dispatcher,ProgressMessage("starting chapter",d));
p = Paragraph("Chapter ");
p.Tag = "chapter title";
append(d,p);
     
close(d);
rptview("test",doctype);

MATLAB セッション中にメッセージ オブジェクトの報告が重複するのを避けるには、リスナーを削除します。

delete(l);

MATLAB コマンド ウィンドウで進行状況メッセージをチェックします。事前定義された DOM 進行状況メッセージに加えて、starting chapter メッセージが表示されます。

バージョン履歴

R2014b で導入

参考

| | |

トピック