slreportgen.finder.DataDictionaryFinder class

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

Найдите словари данных

Описание

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

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

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

HandleCompatible
true

Для получения информации об атрибутах класса см. Атрибуты класса.

Создание

Описание

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

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

Примечание

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

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

  2. Чтобы выполнить итерации через результаты по одному, используйте hasNext и next методы в a 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 и пакеты API Отчета Simulink так, чтобы вы не использовали долго, полностью определенные имена классов.

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
Для просмотра документации необходимо авторизоваться на сайте