ModelAdvisor.FormatTemplate

モデルアドバイザーの解析結果を書式設定するためのテンプレート

説明

ModelAdvisor.FormatTemplate クラスを使用してモデルアドバイザーの解析結果ペインでのチェック結果を書式設定することにより、作成したチェックの外観を統一します。解析結果はテーブルまたはリストとして書式設定できます。

作成

構文

obj = ModelAdvisor.FormatTemplate(type)

説明

obj = ModelAdvisor.FormatTemplate(type) は、ModelAdvisor.FormatTemplate クラスのオブジェクトを作成します。type は、テンプレートの書式タイプ (リストまたはテーブル) を識別する文字ベクトルです。

書式設定された結果を解析結果ペインに表示するには、結果オブジェクトをモデルアドバイザーに返す必要があります。

メモ

チェックのコールバックで ModelAdvisor.FormatTemplate クラスを使用します。

入力引数

すべて展開する

`type` — テンプレートのタイプ
`ListTemplate` | `TableTemplate`

ModelAdvisor.FormatTemplate のタイプ

オブジェクト関数

`addRow`	モデルアドバイザー解析結果で行をテーブルに追加
`setCheckText`	Add description of check to result
`setColTitles`	モデルアドバイザー解析結果で列タイトルをテーブルに追加
`setInformation`	Add description of subcheck to result
`setListObj`	モデルオブジェクトへのハイパーリンクのリストの追加
`setRecAction`	Add Recommended Action section and text
`setRefLink`	[参考] セクションおよびリンクを追加する
`setSubBar`	サブチェックの結果と結果の間にラインを追加する
`setSubResultStatus`	ステータスをチェックまたはサブチェックの結果に追加する
`setSubResultStatusText`	Add text below status in result
`setSubTitle`	結果にサブチェックのタイトルを追加する
`setTableInfo`	Add data to table
`setTableTitle`	Add title to table in Model Advisor analysis results

例

すべて折りたたむ

モデルアドバイザーの結果の書式設定

以下の sl_customization ファイルには、2 つのテンプレートオブジェクト ft1 および ft2 を作成し、それらを使用してチェックの実行結果をテーブルとリストで書式設定するコードが含まれています。結果では、モデル内のブロックが識別されています。

function sl_customization(cm)

% register custom checks
cm.addModelAdvisorCheckFcn(@defineModelAdvisorChecks);

% register custom factory group 
cm.addModelAdvisorTaskFcn(@defineModelAdvisorTasks);

end


% -----------------------------
% defines Model Advisor Checks
% -----------------------------
function defineModelAdvisorChecks

% Define and register a sample check 
rec = ModelAdvisor.Check('mathworks.example.SampleDetailStyle');
rec.Title = 'Sample check for Model Advisor using the ModelAdvisor.FormatTemplate';
setCallbackFcn(rec, @SampleDetailStyleCallback,'None','DetailStyle');

mdladvRoot = ModelAdvisor.Root;
mdladvRoot.register(rec);

end


% -----------------------------
% defines Model Advisor Tasks
% -----------------------------
function defineModelAdvisorTasks
mdladvRoot = ModelAdvisor.Root;
 
% --- sample factory group
rec = ModelAdvisor.FactoryGroup('com.mathworks.sample.factorygroup');
rec.DisplayName='My Group 1';
rec.Description='Demo Factory Group';
rec.addCheck('mathworks.example.SampleDetailStyle');
mdladvRoot.publish(rec); % publish inside By Group list

end


% -----------------------------
% Sample Check With Subchecks Callback Function
% -----------------------------
function [ResultDescription] = SampleDetailStyleCallback(system, CheckObj)

% Initialize variables
ElementResults = ModelAdvisor.ResultDetail.empty();

% Perform the check actions
allBlocks = find_system(system);
[ResultDescription] = getFormattedTemplate(allBlocks);

% Perform the subcheck actions - Result Details - Table
if length(allBlocks) == 1
    % Add result details for detailed style check
    ElementResults(end + 1) = ModelAdvisor.ResultDetail;
    ElementResults(end).ViolationType = 'warn';
    ElementResults(end).Description =  ['Find and report all blocks in a table. '...
        '(setInformation method - Description of what the subcheck reviews)'];
    ElementResults(end).Status =  ['The model does not contain blocks. '...
        '(setSubResultStatusText method - Description of result status)'];   
else  
    for i=1:numel(allBlocks)
        ElementResults(end+1) = ModelAdvisor.ResultDetail;
        ElementResults(end).ViolationType = 'pass';
        ElementResults(end).Format = 'Table';       
        ModelAdvisor.ResultDetail.setData(ElementResults(end),'SID',allBlocks{i});
        ElementResults(end).Description =  ['Find and report all blocks in a table. '...
            '(setInformation method - Description of what the subcheck reviews)'];
        ElementResults(end).Status = ['The model contains blocks. '...
            '(setSubResultStatusText method - Description of result status)'];
    end    
end

% Perform the subcheck actions  - Result Details - List
if length(allBlocks) == 1
     ElementResults(end+1) = ModelAdvisor.ResultDetail;
     ElementResults(end).ViolationType = 'warn';
     ElementResults(end).Description =  ['Find and report all blocks in a table. '...
        '(setInformation method - Description of what the subcheck reviews)'];
     ElementResults(end).Status =  ['The model does not contain blocks. '...
        '(setSubResultStatusText method - Description of result status)'];    
else   
    for i= 1:numel(allBlocks) 
        ElementResults(end+1) = ModelAdvisor.ResultDetail;
        ElementResults(end).ViolationType = 'pass';       
        ModelAdvisor.ResultDetail.setData(ElementResults(end),'SID',allBlocks{i});
        ElementResults(end).Description =  ['Find and report all blocks in a list. '...
            '(setInformation method - Description of what the subcheck reviews)'];
        ElementResults(end).Status = ['The model contains blocks. '...
            '(setSubResultStatusText method - Description of result status)'];  
    end    
end

%Set check result details
CheckObj.setResultDetails(ElementResults);

end

function [ResultDescription] = getFormattedTemplate(allBlocks)
ResultDescription={};

% Create FormatTemplate object for first subcheck, specify table format
ft1 = ModelAdvisor.FormatTemplate('TableTemplate');

% Add information describing the overall check
setCheckText(ft1, ['Find and report all blocks in the model. '...
    '(setCheckText method - Description of what the check reviews)']);

% Add information describing the subcheck
setSubTitle(ft1, 'Table of Blocks (setSubTitle method - Title of the subcheck)');
setInformation(ft1, ['Find and report all blocks in a table. '...
    '(setInformation method - Description of what the subcheck reviews)']);

% Add See Also section for references to standards
setRefLink(ft1, {{'Standard 1 reference (setRefLink method)'},
    {'Standard 2 reference (setRefLink method)'}});

% Add information to the table
setTableTitle(ft1, {'Blocks in the Model (setTableTitle method)'});
setColTitles(ft1, {'Index (setColTitles method)',
    'Block Name (setColTitles method)'});


if length(allBlocks) == 1
    % Add status for subcheck
    setSubResultStatus(ft1, 'Warn');
    setSubResultStatusText(ft1, ['The model does not contain blocks. '...
        '(setSubResultStatusText method - Description of result status)']);
    setRecAction(ft1, {'Add blocks to the model. '...
        '(setRecAction method - Description of how to fix the problem)'});    
else
    % Add status for subcheck
    setSubResultStatus(ft1, 'Pass');
    setSubResultStatusText(ft1, ['The model contains blocks. '...
        '(setSubResultStatusText method - Description of result status)']);
    for inx = 2 : length(allBlocks)
        % Add information to the table
        addRow(ft1, {inx-1,allBlocks(inx)});
    end    
end

% Pass table template object for subcheck to Model Advisor
ResultDescription{end+1} = ft1;

% Create FormatTemplate object for second subcheck, specify list format
ft2 = ModelAdvisor.FormatTemplate('ListTemplate');

% Add information describing the subcheck
setSubTitle(ft2, 'List of Blocks (setSubTitle method - Title of the subcheck)');
setInformation(ft2, ['Find and report all blocks in a list. '...
    '(setInformation method - Description of what the subcheck reviews)']);

% Add See Also section for references to standards
setRefLink(ft2, {{'Standard 1 reference (setRefLink method)'},
    {'Standard 2 reference (setRefLink method)'}});

% Last subcheck, suppress line
setSubBar(ft2, false);

% Perform the subcheck actions
if length(allBlocks) == 1
    % Add status for subcheck
    setSubResultStatus(ft2, 'Warn');
    setSubResultStatusText(ft2, ['The model does not contain blocks. '...
        '(setSubResultStatusText method - Description of result status)']);
    setRecAction(ft2, {'Add blocks to the model. '...
        '(setRecAction method - Description of how to fix the problem)'});
   
else
    % Add status for subcheck
    setSubResultStatus(ft2, 'Pass');
    setSubResultStatusText(ft2, ['The model contains blocks. '...
        '(setSubResultStatusText method - Description of result status)']);
    % Add information to the list
    setListObj(ft2, allBlocks);
end

% Pass list template object for the subcheck to Model Advisor
ResultDescription{end+1} = ft2;

end

sl_customization ファイルを作業ディレクトリに保存します。
MATLAB コマンドウィンドウで次を入力します。
```
Advisor.Manager.refresh_customizations
```
モデルを開きます。
[モデル化] タブで、[モデルアドバイザー] を選択します。
[タスク別] 、 [My Group 1] フォルダーで、[Sample check for Model Advisor using ModelAdvisor.FormatTemplate] を選択します。
[このチェックを実行] をクリックします。
次の図は、チェックがパスしたときにモデルアドバイザーに表示される出力です。
次の図は、チェックから警告が出たときにモデルアドバイザーに表示される出力です。

代替方法

ModelAdvisor.Check オブジェクトを定義する際に、CallbackStyle プロパティで DetailStyle を指定すれば、モデルアドバイザーレポートに表示される結果を ModelAdvisor.FormatTemplate API などの書式設定 API を使用して書式設定しなくても済みます。DetailStyle ではブロック、サブシステム、または推奨アクション別に結果を表示することもできます。

既定の書式設定では要件が満たされない場合、ModelAdvisor.FormatTemplate API または他の書式設定 API を使用します。ModelAdvisor.FormatTemplate クラスを使用すると、作成したチェック間の外観を統一できます。