getVariableID

クラス: slreportgen.finder.ModelVariableResult
名前空間: slreportgen.finder

モデル変数の固有 ID の取得

R2019b 以降

構文

varID = getVariableID(variableResult)

説明

varID = getVariableID(variableResult) は、モデル変数検索の結果によって表される変数を一意に識別する string を返します。この ID は、変数の slreportgen.report.ModelVariable レポーターの LinkTarget プロパティの既定値です。そのため、この ID を使用して、変数についてレポートされた内容へのリンクを生成できます。

入力引数

すべて展開する

`variableResult` — モデル変数を表す結果
`slreportgen.finder.ModelVariableResult` オブジェクト

slreportgen.finder.ModelVariableFinder オブジェクトの find または next メソッドを使用した検索の結果。

出力引数

すべて展開する

`varID` — 変数 ID
string スカラー

モデル変数の固有 ID。string スカラーとして返されます。

例

すべて展開する

内容へのリンクを含む変数のリストの作成

getVariableID メソッドによって返される変数 ID を使用して、変数についてレポートされた内容へのリンクを作成できます。この例では、slrgex_sf_car モデルで使用される変数のレポートを生成します。レポートの先頭にある変数のリストに、変数についてレポートされた内容へのリンクが示されます。

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

openExample('rptgenext/SimulinkReportGeneratorFilesExample');

% Create a Report
rpt = slreportgen.report.Report("MyReport","pdf");

% Load the model
model_name = "slrgex_sf_car";
load_system(model_name);

% Create a Chapter
chapter = mlreportgen.report.Chapter();
chapter.Title = sprintf("Variables Used in the %s model",model_name);

% Find the variables in the model
finder = slreportgen.finder.ModelVariableFinder(model_name);
results = find(finder);

% Create a list of the variables with links to the reported variable content
ul = mlreportgen.dom.OrderedList;
for r = results
    varname = r.Name;
    %get ID that is used for the link target for this variable
    varid = getVariableID(r);
    link = mlreportgen.dom.InternalLink(varid,varname);
    li = mlreportgen.dom.ListItem();
    append(li,link);
    append(ul,li);
end
add(chapter,ul);

% Add reporters for the variables to report
for r = results
    % Get the ModelVariable reporter for the result
    % Customize the formatting of numbers
    reporter = getReporter(r);
    reporter.NumericFormat = "%.4f";
    
    % Add the reporter to the chapter
    add(chapter,reporter);
    
end
add(rpt,chapter);

% Close the report and open the viewer
close(rpt);
rptview(rpt);