exponenta event banner

slreportgen.finder.DataDictionateFinder класс

Пакет: slreportgen.finder
Суперклассы: mlreportgen.finder.Finder

Поиск словарей данных

Описание

Использование объекта slreportgen.finder.DataDictionaryFinder для поиска словарей данных Simulink ®.

slreportgen.finder.DataDictionaryFinder класс является handle класс.

Атрибуты класса

HandleCompatible
true

Сведения об атрибутах класса см. в разделе Атрибуты класса.

Создание

Описание

finder = slreportgen.finder.DataDictionaryFinder() создает поиск словаря данных и устанавливает Container свойство для 'MATLABPath'.

Можно ограничить поиск, задав свойства поиска. Используйте методы поиска для выполнения поиска.

Примечание

Этот поисковик предоставляет два способа получения результатов поиска:

  1. Чтобы вернуть результаты поиска в виде массива, используйте find способ. Добавление результатов непосредственно в отчет или обработка результатов в for цикл.

  2. Чтобы выполнить итерацию результатов по одному, используйте hasNext и next методы в while цикл.

Ни один из вариантов не имеет преимущества в производительности.

finder = slreportgen.finder.DataDictionaryFinder(searchFolder) создает поиск словаря данных и устанавливает Container в папку или папки, указанные searchFolder.

finder = slreportgen.finder.DataDictionaryFinder(Name,Value) задает свойства, используя пары имя-значение. Можно указать несколько аргументов пары имя-значение в любом порядке. Заключите каждое имя свойства в одинарные или двойные кавычки.

Свойства

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

Папки для поиска словарей данных, указанных как строковый массив, символьный вектор или массив ячеек символьных векторов. Строки и векторы символов могут включать * и ** подстановочные знаки. Символы рядом с ** подстановочный знак должен быть разделителем файлов. Например, чтобы найти все словари данных в exampleFolder папка и ее подпапки, набор Container кому "exampleFolder\**". Если Container имеет значение 'MATLABPath', поисковик ищет словари данных в текущей папке и все папки на пути MATLAB ®.

Словарь данных для поиска, указанный как строковый скалярный или символьный вектор. Name значение свойства может включать подстановочный символ *. Например, чтобы найти все словари данных, которые начинаются с sldemo_fuelsys_dd, установите Name свойство для "sldemo_fuelsys_dd*". Имя или выражение, указанное в этом свойстве, не должно иметь расширения имени файла или расширения .sldd.

Свойства словарей данных для поиска, заданные как массив ячеек пар имя-значение. Используйте Properties для фильтрации результатов поиска по свойствам словаря данных. Поисковик выполняет поиск по папкам, указанным в Container для словарей данных с именами, соответствующими Name и, которые имеют указанные значения свойств. Свойства словаря данных см. в разделе Simulink.data.Dictionary. Например, чтобы вернуть только те словари данных, которые имеют доступ к базовой рабочей области, установите Properties кому {'HasAccessToBaseWorkspace',true}.

Методы

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

Примеры

свернуть все

Для создания отчета по словарям данных создайте slreportgen.DataDictionaryFinder объект. Используйте свойства объекта для ограничения поиска и методы для получения результатов.

Импортируйте пакеты MATLAB Report и Simulink Report API, чтобы не использовать длинные, полные имена классов.

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

Создайте отчет Simulink и добавьте к нему оглавление.

rpt = slreportgen.report.Report("MyReport","html-file");
append(rpt,TableOfContents);

Создайте поиск словаря данных Simulink для поиска по всему пути MATLAB.

f = DataDictionaryFinder();

Ограничение поиска только словарей данных с именами, начинающимися с sldemo_fuelsys_dd.

f.Name = "sldemo_fuelsys_dd*";

Создайте главу для словарей данных.

ch = Chapter("Data Dictionaries");

Для каждого найденного словаря создайте раздел и добавьте его в главу.

while hasNext(f)
    result = next(f);
    s = Section(result.Name);
    append(s,result);
    append(ch,s);
end

Добавьте главу к отчету. Закройте и просмотрите отчет.

append(rpt,ch);
close(rpt);
rptview(rpt);
Представлен в R2020b