Exponenta Banner

slreportgen.finder.DataDictionaryFinder class

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

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

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

Описание

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

The 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® путь.

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

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

Методы

расширить все

Примеры

свернуть все

Открыть Live Script

Чтобы сообщить о словарях данных, создайте 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

Simulink Report Generator

Поддержка