このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。

slreportgen.report.ModelConfiguration クラス

名前空間: slreportgen.report
スーパークラス: slreportgen.report.Reporter

モデル コンフィギュレーション セット レポーター

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

説明

slreportgen.report.ModelConfiguration クラスのオブジェクトを使用して、モデルのアクティブなコンフィギュレーション セットについてレポートします。

メモ

レポートで slreportgen.report.ModelConfiguration レポーターを使用するには、slreportgen.report.Report クラスまたはサブクラスを使用してレポートを作成する必要があります。

slreportgen.report.ModelConfiguration クラスは handle クラスです。

クラス属性

HandleCompatible
true

クラス属性の詳細については、クラスの属性を参照してください。

作成

説明

reporter = slreportgen.report.ModelConfiguration は、既定のテンプレートに基づいて空の ModelConfiguration レポーター オブジェクトを作成します。Model プロパティを設定して、アクティブなコンフィギュレーション セットをレポートする対象のモデルを指定する必要があります。その他のプロパティを使用してレポート オプションを指定します。

reporter = slreportgen.report.ModelConfiguration(model) は、ModelConfiguration レポーター オブジェクトを作成し、Model プロパティを指定されたモデルに設定します。

例

reporter = slreportgen.report.ModelConfiguration(Name=Value) は、名前と値のペアを使用してレポーター プロパティを設定します。複数の名前と値のペアの引数を任意の順序で指定できます。

プロパティ

すべて展開する

開いているか読み込まれている Simulink® モデルの名前またはハンドル。string スカラー、文字ベクトル、またはハンドルとして指定します。

コンフィギュレーション セットのタイトル。文字ベクトル、string スカラー、mlreportgen.dom.Text オブジェクト、mlreportgen.dom.InternalLink オブジェクト、または mlreportgen.dom.ExternalLink オブジェクトとして指定します。

FormatPolicy プロパティが "Inline Text" に設定されている場合、Title プロパティの設定に応じて次のようになります。

  • DOM オブジェクトの場合、DOM オブジェクトで指定された形式は無視されます。

  • mlreportgen.dom.InternalLink または mlreportgen.dom.ExternalLink オブジェクトの場合、タイトルにリンク テキストが使用されますが、タイトルがリンクにはなりません。

どちらの場合も、タイトルの形式を設定するには、この ModelConfiguration レポーターの TextFormatter プロパティを使用します。

タイトルを指定しない場合、モデル名の後に Configuration Set を付けたタイトルになります。次に例を示します。

sf_car Configuration Set

コンフィギュレーション セットのレポートの形式。次のいずれかの string または文字ベクトルとして指定します。

  • "Auto" — コンフィギュレーション セット、コンポーネント、およびプロパティ値をデータ型に応じてテーブルまたは段落のいずれかの形式で示します。

    テーブルの形式になるデータ型には以下が含まれます。

    • cell 配列

    • logical 配列

    • 数値配列

    • MATLAB® table

    • Simulink オブジェクト

    • Stateflow® オブジェクト

    • グラフィックス オブジェクト

    • MATLAB 構造体または構造体配列

    • MATLAB オブジェクトまたはオブジェクト配列

    段落の形式になるデータ型には以下が含まれます。

    • cell ベクトル

    • logical スカラーまたはベクトル

    • 数値スカラーまたはベクトル

    • 文字または文字配列

    • string

    • MATLAB 構造体ベクトル

    • MATLAB オブジェクト ベクトル

    コンフィギュレーション セットとコンポーネントはオブジェクトであるため、テーブルの形式になります。プロパティ値については、値のデータ型に応じて形式が決まります。

  • "Table" — 値をテーブルの形式で示します。既定では段落として表示されるデータ型が、代わりにテーブル エントリの形式で示されます。階層構造のオブジェクトである MATLAB 構造体、MATLAB オブジェクト、Simulink オブジェクト、Stateflow オブジェクト、グラフィックス オブジェクトなどのデータ型は、それ自体がオブジェクトであるプロパティをもつことがあります。そのような場合、階層がフラット化され、プロパティ値がフィールドまたはオブジェクト プロパティのテーブルへのハイパーリンクになります。フィールドまたはプロパティのテーブルからも元のテーブルにリンクします。

  • "Paragraph" — コンフィギュレーション セットの記述を段落として生成します。次に例を示します。

    First paragraph is "Source Type :Model". Second paragraph is "Source Name: sf_car". Third paragraph is "sf_car Configuration Set. Configuration (Active)".

  • "Inline Text" — コンフィギュレーション セットの記述を周囲のテキストと共にインラインで生成します。次に例を示します。

    Single line of inline text, reading "sf_car Configuration Set Configuration (Active) in sf_car (Model)"

ModelConfiguration レポーターで生成されるテーブルのテーブル フォーマッタ。mlreportgen.report.BaseTable オブジェクトとして指定します。このプロパティの既定値は、TableStyleName プロパティが ModelConfigurationTable スタイルに設定された BaseTable オブジェクトであり、これは ModelConfiguration レポーターの既定のテンプレートに定義されています。テーブルの外観をカスタマイズするには、既定の BaseTable オブジェクトのプロパティを変更するか、そのオブジェクトを独自の BaseTable オブジェクトに置き換えます。Title プロパティにコンテンツを追加すると、生成されたレポートでテーブルのタイトルの前にそのコンテンツが表示されます。

段落として生成されるモデル コンフィギュレーションの内容の段落フォーマッタ。mlreportgen.dom.Paragraph オブジェクトとして指定します。このプロパティの既定値は、StyleName プロパティが ModelConfigurationParagraph スタイルに設定された Paragraph オブジェクトであり、これは ModelConfiguration レポーターの既定のテンプレートに定義されています。段落の外観をカスタマイズするには、既定の Paragraph オブジェクトのプロパティを変更するか、そのオブジェクトを独自の Paragraph オブジェクトに置き換えます。段落オブジェクトに内容を追加すると、生成されたレポートでモデル コンフィギュレーションの内容の前にその内容が表示されます。

インライン テキストとして生成されるモデル コンフィギュレーションの内容のテキスト フォーマッタ。mlreportgen.dom.Text オブジェクトとして指定します。既定では、このプロパティの値は空の Text オブジェクトです。テキストの外観をカスタマイズするには、既定の mlreportgen.dom.Text オブジェクトのプロパティを変更するか、そのオブジェクトをカスタマイズした mlreportgen.dom.Text オブジェクトに置き換えます。Text オブジェクトに内容を追加すると、生成されたレポートでモデル コンフィギュレーションの内容の前にその内容が表示されます。

値テーブルのテーブル列の最大数。正の整数として指定します。テーブルを使用したプロパティ値のレポートで、列の数が MaxCols プロパティの値よりも多い場合、テーブルは縦方向にスライス化されます。スライス化により、テーブルが複数のテーブルに分割されます。

構造化されたオブジェクト階層でレポート対象とする入れ子レベルの最大数。非負の整数として指定します。階層の最上位レベルはコンフィギュレーション セット オブジェクト (Simulink.ConfigSet) です。DepthLimit の値以下のレベルは、一連の連結されたテーブルにフラット化されます。深さの制限を超えるレベルはレポートされません。DepthLimit プロパティを 0 に設定すると、階層構造の型が展開されません。

オブジェクト階層でレポート対象とするオブジェクトの最大数。正の整数として指定します。

コンフィギュレーション セットのタイトルを含めるかどうか。true または false として指定します。

IncludeTitle が true の場合、コンフィギュレーション セットのタイトル (Title プロパティの内容) が以下に含まれます。

  • FormatPolicy が "Auto" または "Table" の場合はコンフィギュレーション セットのプロパティ テーブルのタイトル

  • FormatPolicy が "Inline Text" または "Paragraph" の場合は生成される内容

コンフィギュレーション セットのコンポーネントを含む段落またはテーブルのタイトルには、IncludeTitle プロパティの値に関係なく、コンフィギュレーション セットのタイトルが常に含まれます。

タイトルで記述する値のデータ型をタイトルに含めるかどうか。true または false として指定します。

データ型: logical

空の値をもつコンフィギュレーション セットまたはコンポーネントのプロパティを表示するかどうか。true または false として指定します。

データ型: logical

既定値を使用するコンフィギュレーション セットまたはコンポーネントのプロパティを表示するかどうか。true または false として指定します。

データ型: logical

コンフィギュレーション セットおよびコンポーネントのオブジェクト プロパティをレポートからフィルター処理するための関数または式。関数ハンドル、string スカラー、または文字ベクトルとして指定します。関数は関数ハンドルとして指定します。式は string スカラーまたは文字ベクトルとして指定します。PropertyFilterFcn が空の場合、すべてのプロパティがレポートに含まれます。

関数ハンドルを指定する場合、関連付けられた関数は次を行う必要があります。

  • 次の引数を受け入れる。

    • variableName — レポート対象の変数の名前

    • variableObject — レポート対象の変数

    • propertyName — レポート対象の変数のプロパティの名前

  • レポートから指定されたプロパティをフィルター処理するには true を返し、プロパティをレポートに含めるには false を返す。

次のコマンドを実行して、この例で使用するサポート ファイルにアクセスします。

openExample('rptgenext/SimulinkReportGeneratorFilesExample');

たとえば、次のコードは PropertyFilterFcn プロパティを使用して、Name プロパティと Description プロパティを表示しないようにします。

import slreportgen.report.*

rpt = slreportgen.report.Report("MyReport","pdf");
open(rpt);

model = "sf_car";
load_system(model);
reporter = ModelConfiguration(model);

filterFcnHandle = @(variableName,variableObject,propertyName) ...
    (propertyName == "Name") ||  ...
    (propertyName == "Description");

reporter.PropertyFilterFcn = filterFcnHandle;
append(rpt,reporter);
close(rpt);
rptview(rpt);

string スカラーまたは文字ベクトルを指定する場合、式が含まれていなければなりません。その式は次のとおりです。

  • 変数 variableName、variableObject、および propertyName を使用できる

  • レポートから指定されたプロパティをフィルター処理するには変数 isFiltered を true に設定し、レポートにプロパティを含めるには false に設定する必要がある

たとえば、次のコードは PropertyFilterFcn プロパティを使用して、Name プロパティと Description プロパティを表示しないようにします。

import slreportgen.report.*

rpt = slreportgen.report.Report("MyReport","pdf");
open(rpt);

model = "sf_car";
load_system(model);
reporter = ModelConfiguration(model);


filterStr = "isFiltered = " +...
    "strcmp(propertyName,'Name')||strcmp(propertyName,'Description');";
reporter.PropertyFilterFcn = filterStr;

append(rpt,reporter);
close(rpt);
rptview(rpt);

整数以外の数値の表示に使用する形式または精度。string スカラー、文字ベクトル、または正の整数として指定します。

形式は string スカラーまたは文字ベクトルとして指定します。sprintf のリファレンス ページで引数 formatSpec を参照してください。

精度は正の整数として指定します。num2str のリファレンス ページで引数 precision を参照してください。

例: "%.2f" は、double 値を小数点以下 2 桁まで表示します。

例: 2 は、最大有効桁数 2 桁まで表示します。

このレポーターのテンプレートのソース。以下のいずれかの方法で指定します。

  • このレポーターのテンプレートを含むファイルのパスを指定する、文字ベクトルまたは string スカラー

  • このレポーターに使用されているテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、レポーターまたはレポート

  • このレポーターに使用されているテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、ドキュメント オブジェクト モデル (DOM) のドキュメントまたはドキュメント パーツ

指定されるテンプレートは、このレポートが追加されるレポーターと同じタイプでなければなりません。たとえば、Microsoft® Word レポートの場合、TemplateSrc は Word レポーター テンプレートでなければなりません。TemplateSrc プロパティが空の場合、このレポーターはレポートの出力タイプで既定のレポーター テンプレートを使用します。

このレポーター テンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーター テンプレートは、このレポーターの TemplateSrc プロパティで指定されたテンプレートのテンプレート ライブラリになければなりません。

データ型: char | string

このレポーターのハイパーリンク ターゲット。リンク ターゲット ID を指定する文字ベクトルまたは string スカラー、あるいは mlreportgen.dom.LinkTarget オブジェクトとして指定します。文字ベクトルまたは string スカラーの値は LinkTarget オブジェクトに変換されます。リンク ターゲットは、出力レポートでこのレポーターのコンテンツの直前に配置されます。

メソッド

すべて展開する

例

すべて折りたたむ

ライブ スクリプトを開く

slreportgen.report.ModelConfiguration クラスのオブジェクトを使用して、アクティブなモデル コンフィギュレーション セットについてレポートします。

長い完全修飾クラス名を使用せずに済むように、MATLAB レポートおよび Simulink レポートの API パッケージをインポートします。

import mlreportgen.report.*
import slreportgen.report.*

Simulink レポートを作成します。

rpt = slreportgen.report.Report("MyReport","pdf");
open(rpt);

アクティブなモデル コンフィギュレーション セットの章を作成します。

chapter = Chapter();
chapter.Title = "Active Model Configuration Set";

モデルを読み込みます。

model = "sf_car";
load_system(model);

slreportgen.report.ModelConfiguration オブジェクトを作成して、モデルのアクティブなコンフィギュレーション セットについてレポートします。

reporter = ModelConfiguration(model);

レポーターを章に追加し、その章をレポートに追加します。

append(chapter,reporter);
append(rpt,chapter);

レポートを閉じて表示します。

close(rpt);
rptview(rpt);

バージョン履歴

R2020b で導入

参考

トピック