exponenta event banner

класс slreportgen.report.DataDictionary

Пакет: slreportgen.report
Суперклассы: slreportgen.report.Reporter

Репортер словаря данных Simulink

Описание

Использование объекта slreportgen.report.DataDictionary для создания отчета по словарю данных Simulink ®. Создать DataDictionary объект для создания отчета по определенному словарю данных. Либо используйте slreportgen.finder.DataDictionaryFinder для поиска словарей данных и использования getReporter метод slreportgen.finder.DataDictionaryResult возвратить репортер для результата.

Примечание

Использование slreportgen.report.DataDictionary reporter в отчете, необходимо создать отчет с помощью slreportgen.report.Report класс или подкласс.

slreportgen.report.DataDictionary класс является handle класс.

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

HandleCompatible
true

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

Создание

Описание

reporter = slreportgen.report.DataDictionary() создает DataDictionary на основе шаблона по умолчанию. Используйте свойства reporter для определения словаря данных и параметров отчета. Необходимо указать словарь данных для отчета. Добавление к отчету пустого объекта reporter словаря данных приводит к ошибке.

пример

reporter = slreportgen.report.DataDictionary(dictionaryName) создает DataDictionary reporter и устанавливает свойство Dictionary для указанного словаря данных. Используйте свойства reporter для задания параметров отчета.

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

Свойства

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

Словарь данных для отчета, указанный как вектор символов или строковый скаляр, содержащий имя файла словаря по пути MATLAB ® или путь и имя файла словаря данных. Путь может быть относительным или абсолютным.

Пример: "sldemo_fuelsys_dd.sldd"

Пример: "myDictionaries/myDataDictionary.sldd"

Свойства для отчета по каждой статье словаря данных в таблице сводок, задаваемые как строковый массив или массив ячеек символьных векторов. Допустимые свойства:

  • Name

  • Value

  • Class

  • LastModified

  • LastModifiedBy

  • Status

  • DataSource

Value содержит значение, если тип данных является числовым скаляром, логическим скаляром, строковым скаляром или символьным вектором. В противном случае Value запись - See details.

Пример: ["Name" "Value" "Class" "LastModified" "LastModifiedBy" "Status" "DataSource"]

Пример: {'Name' 'Value' 'Class'}

Следует ли сообщать раздел Design Data словаря данных, указанный как true или false.

Типы данных: logical

Следует ли сообщать раздел Конфигурации словаря данных, указанный как true или false.

Типы данных: logical

Следует ли сообщать раздел «Прочие данные» словаря данных, указанный как true или false.

Типы данных: logical

Включать ли словари, на которые ссылается словарь, о котором сообщает этот репортер, указанный как true или false. ReferencedDictionaryPolicy определяет, каким образом будут сообщаться словари, на которые имеются ссылки.

Типы данных: logical

Отображение политики для сообщения о словаре, на который указывает ссылка, в качестве одного из следующих значений:

  • "SameTable" - Отчет по ссылочным словарным статьям в той же таблице, что и основные словарные статьи. Подробные данные отображаются в том порядке, в котором они отображаются в сводной таблице. Это значение является значением по умолчанию.

  • "SeparateTables" - создание отдельной таблицы для каждого словаря, на который имеется ссылка. Ссылочные сводные таблицы словаря отображаются сразу после основной сводной таблицы. Репортеры о словаре, на которые имеются ссылки, отображаются после репортеров об основном словаре.

  • "List" - Сообщить список словарей, на которые имеются ссылки. Элементы списка ссылаются на отдельные отчеты словаря данных. Ссылки работают только при добавлении к этому отчету отчетов для словарей, на которые имеются ссылки. Список появляется в разделе «Конструкторские данные» сразу после сводной таблицы словаря. Сводная таблица словаря не включает статьи словаря, на которые имеются ссылки. Сведения о словарных статьях, на которые имеются ссылки, не сообщаются.

Фильтр словарной статьи данных, указанный как дескриптор функции, скаляр строки или символьный вектор. Если вы не предоставите EntryFilterFcn, все записи включаются в отчет.

Если предоставляется дескриптор функции, связанная функция должна:

  • Возьмем следующие аргументы:

  • Вернуть true для фильтрации указанной записи из отчета, или false для включения записи в отчет.

Например, этот код использует EntryFilterFcn свойство для предотвращения сообщения о записях, которые являются Simulink.Parameter объекты:

rpt = slreportgen.report.Report("MyReport","pdf");
ddPath = which("sldemo_fuelsys_dd.sldd");

ch = mlreportgen.report.Chapter("sldemo_fuelsys_dd.sldd");
rptr = slreportgen.report.DataDictionary(ddPath);

filterFcnHandle = @(entryObject, entryValue) ...
    isa(entryValue,"Simulink.Parameter");
rptr.EntryFilterFcn = filterFcnHandle;

append(ch,rptr);
append(rpt,ch);

close(rpt);
rptview(rpt);

Если предоставляется строковый скаляр или символьный вектор, он должен содержать выражение. Выражение:

  • Может использовать переменные entryObject и entryValue

  • Необходимо задать переменную isFiltered кому true для фильтрации указанной записи из отчета, или false для включения записи в отчет

Например, этот код использует EntryFilterFcn свойство для предотвращения сообщения о записях, которые являются Simulink.Bus объекты:

rpt = slreportgen.report.Report("MyReport","pdf");
ddPath = which("sldemo_fuelsys_dd.sldd");

ch = mlreportgen.report.Chapter("sldemo_fuelsys_dd.sldd");
rptr = slreportgen.report.DataDictionary(ddPath);
filterStr = "isFiltered = isa(entryValue,'Simulink.Bus');";
rptr.EntryFilterFcn = filterStr;

append(ch,rptr);
append(rpt,ch);

close(rpt);
rptview(rpt);

Форматер для сводных таблиц записей, указанный как mlreportgen.report.BaseTable объект. Значением по умолчанию этого свойства является BaseTable объект с TableStyleName для свойства установлено значение DataDictionaryTable стиль, определенный в шаблоне по умолчанию для DataDictionary репортер. Чтобы настроить внешний вид таблицы, измените свойства по умолчанию BaseTable объект или замените его настраиваемым BaseTable репортер. При добавлении содержимого в Title содержимое отображается перед заголовком таблицы в созданном отчете.

Средство форматирования для подробных данных записи, указанное как mlreportgen.report.MATLABVariable объект. Значением по умолчанию этого свойства является MATLABVariable со значениями свойств по умолчанию. Чтобы настроить внешний вид сведений о записи, измените свойства по умолчанию MATLABVariable или замените объект своим собственным MATLABVariable репортер. Variable, Location, и LinkTarget свойства MATLABVariable репортер игнорируется.

Средство форматирования списка для списка словарей, на который имеется ссылка, указанное как mlreportgen.dom.UnorderedList объект или mlreportgen.dom.OrderedList объект. Средство форматирования списка используется при ReferencedDictionaryPolicy свойство имеет значение "List". UnorderedList или OrderedList объект не должен содержать элементы списка.

Значением по умолчанию для этого свойства является UnorderedList объект с StyleName для свойства установлено значение DataDictionaryList стиль, который определен в шаблоне по умолчанию DataDictionary репортер. Чтобы настроить внешний вид списка, измените свойства по умолчанию UnorderedList или замените объект своим собственным UnorderedList или OrderedList объект.

Источник шаблона для этого репортера, указанный одним из следующих способов:

  • Вектор символов или строковый скаляр, указывающий путь к файлу, содержащему шаблон для этого репортера

  • Репортер или отчет, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

  • Документ DOM или деталь документа, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

Указанный шаблон должен быть того же типа, что и отчет, к которому добавлен этот репортер. Например, для отчета Microsoft ® Word :TemplateSrc должен быть шаблоном репортера Word. Если TemplateSrc пустое свойство, этот репортер использует шаблон репортера по умолчанию для типа вывода отчета.

Имя шаблона для этого репортера, указанного как вектор символов или скаляр строки. Шаблон для этого репортера должен находиться в библиотеке шаблонов источника шаблона (TemplateSrc) для этого репортера.

Цель гиперссылки для этого репортера, указанная как вектор символов или скаляр строки, указывающий идентификатор цели связи, или mlreportgen.dom.LinkTarget объект. Вектор символов или строковое скалярное значение преобразуется в LinkTarget объект. Цель ссылки непосредственно предшествует содержимому этого репортера в выходном отчете.

Методы

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

Примеры

свернуть все

Использование объекта slreportgen.report.DataDictionary для создания отчета по словарю данных Simulink.

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

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

Создание отчета Simulink.

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

Укажите путь к словарю данных, используемому моделью sldemo_fuelsys_dd.

ddPath = "sldemo_fuelsys_dd.sldd";

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

ch = Chapter("sldemo_fuelsys_dd.sldd");

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

rptr = DataDictionary(ddPath);

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

append(ch,rptr);
append(rpt,ch);

Закройте и просмотрите отчет.

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