getVariableID

Класс: slreportgen.finder.ModelVariableResult
Пакет: slreportgen.finder

Получите уникальный идентификатор переменной модели

Синтаксис

varID = getVariableID(variableResult)

Описание

varID = getVariableID(variableResult) возвращает строку, которая однозначно определяет переменную, представленную переменным результатом поиска модели. Этот ID является значением по умолчанию LinkTarget свойство slreportgen.report.ModelVariable генератор отчетов для переменной. Поэтому можно использовать ID, чтобы сгенерировать ссылку на содержимое, о котором сообщают, для переменной.

Входные параметры

развернуть все

Результат поиска с помощью find или next метод slreportgen.finder.ModelVariableFinder объект.

Выходные аргументы

развернуть все

Уникальный идентификатор для переменной модели, возвращенной как строковый скаляр.

Примеры

развернуть все

Можно использовать идентификатор переменной, возвращенный getVariableID метод, чтобы создать ссылку на содержимое, о котором сообщают, для переменной. Этот пример генерирует отчет переменных, используемых sf_car модель. Список переменных в начале отчета обеспечивает ссылки на содержимое, о котором сообщают, для переменных.

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

% Load the model
model_name = "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);

Введенный в R2019b

Для просмотра документации необходимо авторизоваться на сайте