このページの内容は最新ではありません。最新版の英語を参照するには、ここをクリックします。
slreportgen.report.CFunction クラス
名前空間: slreportgen.report
説明
slreportgen.report.CFunction
クラスのオブジェクトを使用して、C Function ブロックについてレポートします。
既定では、CFunction
オブジェクトは次をレポートします。
[説明] パラメーターとすべてのカスタム マスク パラメーターを含むテーブル
[シンボル] パラメーターの内容をリストするテーブル
[出力コード]、[開始コード]、および [終了コード] パラメーターによって定義される C コードのセクション
オブジェクトのプロパティを使用して、レポートされる情報を除外または変更します。
メモ
レポートで CFunction
レポーターを使用するには、slreportgen.report.Report
クラスを使用してレポートを作成する必要があります。
slreportgen.report.CFunction
クラスは handle
クラスです。
作成
説明
は、rptr
= slreportgen.report.CFunction()CFunction
オブジェクトを既定のプロパティ値で作成します。Object
プロパティを設定して、レポート対象の C Function ブロックを指定する必要があります。その他のプロパティを使用してレポート オプションを指定します。
は、レポート対象の C Function ブロックを指定し、rptr
= slreportgen.report.CFunction(cFunctionBlock
)Object
プロパティを cFunctionBlock
に設定します。
は、名前と値の引数を使用してプロパティを設定します。たとえば、rptr
= slreportgen.report.CFunction(Name=Value
)rptr = slreportgen.report.CFunction(Object="slrgex_cfunction/C Function")
は Object
プロパティを "slrgex_cfunction/C Function"
に設定します。複数の名前と値の引数を指定できます。
プロパティ
Object
— レポート対象の Simulink® C Function ブロック
[]
(既定値) | string スカラー | 文字ベクトル | ハンドル | slreportgen.report.BlockResult
オブジェクト
レポート対象の Simulink C Function ブロック。次の値のいずれかとして指定します。
C Function ブロックのパスを含む string スカラーまたは文字ベクトル
C Function ブロックのハンドル
ブロックを表す
slreportgen.finder.BlockResult
オブジェクト。
メモ
ファインダーを使用して C Function ブロックを検索し、その結果をレポートに直接追加する場合、 slreportgen.report.SimulinkObjectProperties
レポーターではなく slreportgen.report.CFunction
レポーターを使用してブロックがレポートされます。
IncludeObjectProperties
— ブロック パラメーターのテーブルを含めるかどうか
true
(既定値) | false
ブロック パラメーターのテーブルを含めるかどうか。true
または false
として指定します。このプロパティが true
の場合、既定では、[説明] パラメーターとすべてのカスタム マスク パラメーターを含むテーブルがレポーターで生成されます。[出力コード]、[開始コード]、[終了コード]、および [シンボル] パラメーターは個別の節でレポートされるため、このテーブルには含まれません。テーブルに含めるパラメーターを指定したり、テーブルの形式をカスタマイズしたりするには、このレポーターの ObjectPropertiesReporter
プロパティを使用します。パラメーターが空の場合、レポーターでテーブルは生成されません。
属性:
GetAccess | public |
SetAccess | public |
IncludeSymbols
— シンボル テーブルを含めるかどうか
true
(既定値) | false
C Function ブロックで使用されるシンボルのテーブルを含めるかどうか。true
または false
として指定します。
属性:
GetAccess | public |
SetAccess | public |
IncludeOutputCode
— 出力コードを含めるかどうか
true
(既定値) | false
C Function ブロックの出力の計算に使用される C コードを含めるかどうか。true
または false
として指定します。
属性:
GetAccess | public |
SetAccess | public |
IncludeStartCode
— 開始コードを含めるかどうか
true
(既定値) | false
シミュレーションの開始時に C Function ブロックの状態の計算に使用される C コードを含めるかどうか。true
または false
として指定します。
属性:
GetAccess | public |
SetAccess | public |
IncludeInitializeConditionsCode
— 初期化コードを含めるかどうか
true
(既定値) | false
C Function ブロックが有効になるたびに実行される初期化用の C コードを含めるかどうか。true
または false
として指定します。このプロパティが true
の場合、条件初期化コードがレポートに含まれます。C Function ブロックで条件初期化コードが定義されていない場合、レポートに何も追加されません。
属性:
GetAccess | public |
SetAccess | public |
IncludeTerminateCode
— 終了コードを含めるかどうか
true
(既定値) | false
C Function ブロックで終了時に実行される C コードを含めるかどうか。true
または false
として指定します。
属性:
GetAccess | public |
SetAccess | public |
ObjectPropertiesReporter
— ブロック プロパティ テーブルのフォーマッタ
slreportgen.report.SimulinkObjectProperties
オブジェクト
C Function ブロックのプロパティ テーブルのフォーマッタ。slreportgen.report.SimulinkObjectProperties
オブジェクトとして指定します。このプロパティの既定値は、空の slreportgen.report.SimulinkObjectProperties
オブジェクトです。ブロック プロパティ テーブルの外観は、既定のオブジェクトのプロパティを変更するか別の SimulinkObjectProperties
オブジェクトに置き換えることでカスタマイズできます。このテーブルに表示するプロパティは、SimulinkObjectProperties
オブジェクトの Properties
を使用して指定できます。Properties
が空の場合、レポーターで表示するプロパティが C Function ブロックのパラメーターに基づいて自動的に決定されます。
属性:
GetAccess | public |
SetAccess | public |
SymbolsReporter
— シンボル テーブルのフォーマッタ
mlreportgen.report.BaseTable
オブジェクト
C Function ブロックで使用されるシンボルのテーブルのフォーマッタ。mlreportgen.report.BaseTable
オブジェクトとして指定します。このプロパティの既定値は、StyleName
プロパティが "CFunctionSymbolsTable"
に設定された空の BaseTable
オブジェクトです。シンボルのテーブルの外観は、既定のオブジェクトのプロパティを変更するか別の BaseTable
オブジェクトに置き換えることでカスタマイズできます。BaseTable
オブジェクトの title プロパティに追加された内容は、レポートで既定で生成されるテーブルのタイトルの前に表示されます。
属性:
GetAccess | public |
SetAccess | public |
データ型:
CodeTitleFormatter
— コードの節のタイトルの段落フォーマッタ
mlreportgen.dom.Paragraph
オブジェクト
レポートの出力コード、開始コード、および終了コードの各節のタイトルの段落フォーマッタ。mlreportgen.dom.Paragraph
オブジェクトとして指定します。このプロパティの既定値は、StyleName
プロパティが "CFunctionCodeTitle"
に設定された空の Paragraph
オブジェクトです。コードの節のタイトルの外観は、既定のオブジェクトのプロパティを変更するか別の Paragraph
オブジェクトに置き換えることでカスタマイズできます。このプロパティで Paragraph
オブジェクトに追加された内容は、レポートでコードのタイトルの前に表示されます。
属性:
GetAccess | public |
SetAccess | public |
データ型:
CodeFormatter
— C コードのフォーマッタ
mlreportgen.dom.Preformatted
オブジェクト
レポートの出力コード、開始コード、および終了コードの各節の C コードのフォーマッタ。mlreportgen.dom.Preformatted
オブジェクトとして指定します。このプロパティの既定値は、StyleName
が "CFunctionCode"
に設定された空の Preformatted
オブジェクトです。C コードの外観は、既定のオブジェクトのプロパティを変更するか別の Preformatted
オブジェクトに置き換えることでカスタマイズできます。このプロパティで Preformatted
オブジェクトに追加された内容は、レポートで書式設定されたコードの前に表示されます。
属性:
GetAccess | public |
SetAccess | public |
TemplateSrc
— レポーターのテンプレートのソース
[]
(既定値) | 文字ベクトル | string スカラー | レポーターまたはレポート | DOM ドキュメントまたはドキュメント パーツ
このレポーターのテンプレートのソース。以下のいずれかの方法で指定します。
このレポーターのテンプレートを含むファイルのパスを指定する、文字ベクトルまたは string スカラー
このレポーターに使用されているテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、レポーターまたはレポート
このレポーターに使用されているテンプレートをもつか、このレポーター用のテンプレートを含むテンプレート ライブラリをもつ、DOM ドキュメントまたはドキュメント パーツ
指定されるテンプレートは、このレポートが追加されるレポートと同じタイプでなければなりません。たとえば、Microsoft® Word レポートの場合、TemplateSrc
は Word レポーター テンプレートでなければなりません。TemplateSrc
プロパティが空の場合、このレポーターはレポートの出力タイプで既定のレポーター テンプレートを使用します。
TemplateName
— レポーター テンプレートの名前
string スカラー | 文字ベクトル
このレポーター テンプレートの名前。文字ベクトルまたは string スカラーとして指定します。このレポーター テンプレートは、このレポーターの TemplateSrc
プロパティで指定されたテンプレートのテンプレート ライブラリになければなりません。
データ型: string
| char
LinkTarget
— このレポーターのハイパーリンク ターゲット
[]
(既定値) | 文字ベクトル | string スカラー | mlreportgen.dom.LinkTarget
オブジェクト
このレポーターのハイパーリンク ターゲット。リンク ターゲット ID を指定する文字ベクトルまたは string スカラー、あるいは mlreportgen.dom.LinkTarget
オブジェクトとして指定します。文字ベクトルまたは string スカラーの値は LinkTarget
オブジェクトに変換されます。リンク ターゲットは、出力レポートでこのレポーターのコンテンツの直前に配置されます。
メソッド
パブリック メソッド
slreportgen.report.CFunction.createTemplate | C Function ブロック レポーター テンプレートの作成 |
slreportgen.report.CFunction.customizeReporter | slreportgen.report.CFunction クラスのサブクラスを作成 |
slreportgen.report.CFunction.getClassFolder | Get location of folder that contains the
slreportgen.report.CFunction class definition file |
copy | Create copy of a Simulink reporter object and make deep copies of certain property values |
getImpl | レポーターの実装を取得する |
例
C Function ブロックについてのレポート
この例では、モデルで使用されている C Function ブロックに関する情報を含むレポートを生成します。
長い完全修飾クラス名を使用せずに済むよう、レポート API パッケージをインポートします。
import mlreportgen.report.* import slreportgen.report.*
レポートを作成します。
rpt = slreportgen.report.Report("output","pdf");
C Function ブロックがあるモデルを読み込みます。
model_name = "slrgex_cfunction"; cFcnObj = "slrgex_cfunction/C Function"; load_system(model_name);
章レポーターを作成します。
chapter = Chapter(cFcnObj);
C Function ブロック レポーターを作成します。既定では、[出力コード]、[開始コード]、[終了コード]、および [シンボル] パラメーターが他のブロック パラメーターと共にレポートに含まれます。この例では、C Function ブロックの [出力コード] パラメーターは空です。
rptr = CFunction(cFcnObj);
C Function レポーターを章に追加し、その章をレポートに追加します。
append(chapter,rptr); append(rpt,chapter);
レポートを閉じて表示します。
close(rpt); close_system(model_name); rptview(rpt);
C Function ブロックについて、次の情報がレポートに含まれます。
バージョン履歴
R2021b で導入
MATLAB コマンド
次の MATLAB コマンドに対応するリンクがクリックされました。
コマンドを MATLAB コマンド ウィンドウに入力して実行してください。Web ブラウザーは MATLAB コマンドをサポートしていません。
Select a Web Site
Choose a web site to get translated content where available and see local events and offers. Based on your location, we recommend that you select: .
You can also select a web site from the following list:
How to Get Best Site Performance
Select the China site (in Chinese or English) for best site performance. Other MathWorks country sites are not optimized for visits from your location.
Americas
- América Latina (Español)
- Canada (English)
- United States (English)
Europe
- Belgium (English)
- Denmark (English)
- Deutschland (Deutsch)
- España (Español)
- Finland (English)
- France (Français)
- Ireland (English)
- Italia (Italiano)
- Luxembourg (English)
- Netherlands (English)
- Norway (English)
- Österreich (Deutsch)
- Portugal (English)
- Sweden (English)
- Switzerland
- United Kingdom (English)