slreportgen.report.SystemIO class

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

Системный ввод и вывод Simulink сигнализирует о генераторе отчетов

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

Описание

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

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

slreportgen.report.SystemIO() создает пустой slreportgen.report.SystemIO объект генератора отчетов. Используйте Object свойство задать модель или подсистему, о которой сообщат. По умолчанию генератор отчетов генерирует сводные таблицы для системных вводов и выводов. Входная сводная таблица приводит источники входных сигналов. Выходная сводная таблица приводит места назначения выходных сигналов. Генератор отчетов также генерирует раздел деталей сигнала, который перечисляет свойства портов ввода и вывода. Используйте свойства генератора отчетов настроить содержимое и внешний вид сгенерированного отчета. Например, используйте DetailsReporter свойство настроить содержимое и внешний вид сигнала детализирует раздел.

пример

slreportgen.report.SystemIO(object) создает генератор отчетов для модели или подсистемы, заданной object. Смотрите Свойство объекта.

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

Свойства

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

Модель Simulink или подсистема, о которой сообщат в виде строкового скаляра или вектора символов, который содержит путь к модели или подсистеме, как указатель на модель или подсистему, как slreportgen.finder.DiagramResult объект, или как slreportgen.finder.BlockResult объект.

Список свойств сообщить для каждого входа в виде массива строк или массива ячеек из символьных векторов. Можно включать эти свойства в список:

  • "Source"

  • "Name"

  • "Description"

  • "DataType"

  • "Complexity"

  • "Dimensions"

  • "Min"

  • "Max"

  • "SampleTime"

  • "Units"

Также можно задать эти свойства Inport block, который соответствует входному сигналу в системе:

  • "Имя блока Inport"

  • "Описание блока Inport"

По умолчанию список включает SourceИмя, и DataType.

Список свойств сообщить для каждого выхода в виде массива строк или массива ячеек из символьных векторов. Можно включать эти свойства в список:

  • "Destination"

  • "Name"

  • "Description"

  • "DataType"

  • "Complexity"

  • "Dimensions"

  • "Min"

  • "Max"

  • "SampleTime"

  • "Units"

Также можно задать эти свойства Outport block, который соответствует выходному сигналу в системе:

  • "Имя блока выходного порта"

  • "Описание блока выходного порта"

По умолчанию список включает DestinationИмя, и DataType.

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

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

Показать ли детали для каждого ввода или вывода в виде true или false. Если ShowDetails true, генератор отчетов вставляет slreportgen.report.SimulinkObjectProperties генераторы отчетов после сводных таблиц ввода и вывода. Если Object модель, детали о блоках ввода или вывода включены. Если Object подсистема, детали о портах ввода или вывода включены. Номера портов в сводных таблицах соединяются с соответствующим SimulinkObjectProperties генератор отчетов для того порта.

Показать ли пустые столбцы в сводных таблицах в виде true или false. Если ShowEmptyColumns true, сводные таблицы включают столбцы, которые не имеют данных.

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

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

Средство форматирования для таблиц детали в виде slreportgen.report.SimulinkObjectProperties генератор отчетов. Значением по умолчанию является SimulinkObjectProperties генератор отчетов. Чтобы настроить внешний вид таблиц детали, измените свойства SimulinkObjectProperties по умолчанию генератор отчетов или замена это с индивидуально настраиваемым SimulinkObjectProperties генератор отчетов.

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

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

Этот пример использует slreportgen.report.SystemIO генератор отчетов, чтобы сообщить относительно вводов и выводов модели и ее подсистем.

model_name = "f14";
load_system(model_name);
% Create a Simulink report
rpt = slreportgen.report.Report("SystemIO_example","docx");

% Create finder to find all diagrams in model
finder = slreportgen.finder.DiagramFinder(model_name);

% Report inputs and outputs of each diagram
ch = mlreportgen.report.Chapter("Diagrams");
while hasNext(finder)
  result = next(finder);
  if strcmpi(result.Type,"Simulink.SubSystem") ...
          || strcmpi(result.Type,"Simulink.BlockDiagram")
      sect = mlreportgen.report.Section(result.Name);
      add(sect,result);
      % Create SystemIO reporter and add to report
      ioRptr = slreportgen.report.SystemIO(result);        
      add(sect,ioRptr);

      add(ch,sect);
  end
end

% Add chapter to report and close report
add(rpt,ch);
close(rpt);
rptview(rpt);

Советы

  • О свойствах сигнала ввода и вывода сообщает SystemIO генератор отчетов соответствует свойствам Simulink, при помощи которых можно запросить get_param. Например, DataType и Dimensions свойства соответствуют CompiledPortDataType Simulink и CompiledPortDimensions свойства указателей порта.

  • Для сигналов шины Simulink определяет значения CompiledPortDataType и CompiledPortDimensions свойства на основе того, является ли сигнал невиртуальной или виртуальной шиной.

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

|

Темы

Введенный в R2020a

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

Поддержка

Для просмотра документации необходимо авторизоваться на сайте