Exponenta Banner
exponenta event banner

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 класс или подкласс.

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

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

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

Свойства

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

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

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

  • Name

  • Value

  • Class

  • LastModified

  • LastModifiedBy

  • Status

  • DataSource

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

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: логический

Сообщить ли о разделе Configurations словаря данных в виде true или false.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: логический

Сообщить ли о разделе Other Data словаря данных в виде true или false.

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: логический

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

Атрибуты:

GetAccess
public
SetAccess
public

Типы данных: логический

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

  • "SameTable" — Сообщите о словарных статьях, на которые ссылаются, в той же таблице как основные словарные статьи. Детали отображены в порядке, что они появляются в сводной таблице. Это значение является значением по умолчанию.

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

  • "List" — Сообщите о списке словарей, на которые ссылаются. Элементы списка соединяются, чтобы разделить генераторы отчетов словаря данных. Ссылки работают, только если вы добавляете генераторы отчетов для словарей, на которые ссылаются, к этому отчету. Список появляется в разделе Design Data, сразу после сводной таблицы словаря. Сводная таблица словаря не включает словарные статьи, на которые ссылаются. О деталях не сообщают для словарных статей, на которые ссылаются.

Атрибуты:

GetAccess
public
SetAccess
public

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

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

  • Возьмите эти аргументы:

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

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

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

ch = mlreportgen.report.Chapter("slrgex_fuelsys.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("slrgex_fuelsys.sldd");

ch = mlreportgen.report.Chapter("slrgex_fuelsys.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);

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

Атрибуты:

GetAccess
public
SetAccess
public

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

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

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

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

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

Атрибуты:

GetAccess
public
SetAccess
public

Имя шаблона для этого генератора отчетов в виде вектора символов или строкового скаляра. Шаблон для этого генератора отчетов должен быть в библиотеке шаблонов шаблона, заданного TemplateSrc свойство этого генератора отчетов.

Атрибуты:

GetAccess
public
SetAccess
public

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

Атрибуты:

GetAccess
public
SetAccess
public

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

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

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

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

Создайте отчет Simulink.

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

Задайте путь словаря данных, используемого моделью slrgex_fuelsys.

ddPath = which("slrgex_fuelsys.sldd");

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

ch = Chapter("slrgex_fuelsys.sldd");

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

rptr = DataDictionary(ddPath);

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

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

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

close(rpt);
rptview(rpt);

Смотрите также

| |

Темы

Введенный в R2020b

Документация Simulink Report Generator

Поддержка