slreportgen.report.DataDictionary class

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

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

Описание

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

Примечание

Как использовать slreportgen.report.DataDictionary репортер в отчете, вы должны создать отчет с помощью slreportgen.report.Report класс или подкласс.

The 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) устанавливает свойства reporter с помощью пар "имя-значение". Можно задать несколько аргументы пары "имя-значение" в любом порядке. Заключайте каждое имя свойства в одинарные или двойные кавычки.

Свойства

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

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

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

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

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

  • Name

  • Value

  • Class

  • LastModified

  • LastModifiedBy

  • Status

  • DataSource

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

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

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

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

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

Нужно ли сообщать о Configurations разделе словаря данных, заданном как true или false.

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

Нужно ли сообщать о Other Data разделе словаря данных, заданном как true или false.

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

Включать ли словари, на которые ссылается словарь, о котором сообщает этот репортер, в виде true или false. The 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 репортер. The Variable, Location, и LinkTarget свойства MATLABVariable репортер игнорируются.

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

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

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

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

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

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

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

Имя шаблона для этого репортера, заданное как вектор символов или строковый скаляр. Шаблон для этого репортера должен быть в библиотеке шаблонов источника шаблона (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