Exponenta Banner
exponenta event banner

класс slreportgen.report.SystemIO

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

Репортер входных и выходных сигналов системы Simulink

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

Описание

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

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

slreportgen.report.SystemIO(object) создает репортер для модели или подсистемы, указанной 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, соответствующего входному сигналу в системе:

  • «Имя блока ввода»

  • «Описание блока ввода»

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

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

  • "Destination"

  • "Name"

  • "Description"

  • "DataType"

  • "Complexity"

  • "Dimensions"

  • "Min"

  • "Max"

  • "SampleTime"

  • "Units"

Можно также указать следующие свойства блока Outport, соответствующего выходному сигналу в системе:

  • «Имя блока исходящего порта»

  • «Описание блока исходящего порта»

По умолчанию список включает Destination, Name, и 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 или деталь документа, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера

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

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

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

Методы

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

Примеры

свернуть все

Открыть сценарий в реальном времени

В этом примере используется 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 reporter соответствуют свойствам Simulink, которые можно запросить с помощью get_param. Например, DataType и Dimensions свойства соответствуют Simulink CompiledPortDataType и CompiledPortDimensions свойства дескрипторов портов.

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

См. также

|

Темы

Представлен в R2020a

Документация по генератору отчетов Simulink

Поддержка