slreportgen.report.SystemIO class

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

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

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

Описание

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

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

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

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

Свойства

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

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

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

  • "Source"

  • "Name"

  • "Description"

  • "DataType"

  • "Complexity"

  • "Dimensions"

  • "Min"

  • "Max"

  • "SampleTime"

  • "Units"

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

  • «Входные Блоки Имени»

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

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

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

  • "Destination"

  • "Name"

  • "Description"

  • "DataType"

  • "Complexity"

  • "Dimensions"

  • "Min"

  • "Max"

  • "SampleTime"

  • "Units"

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

  • «Блок вывода Имени»

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

По умолчанию список включает 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® Отчет о словах, TemplateSrc должен быть шаблоном репортера Word. Если на TemplateSrc свойство пусто, этот репортер использует шаблон reporter по умолчанию для типа выхода отчета.

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

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

Методы

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

Примеры

свернуть все

Открыть Live Script

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

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 свойства соответствуют CompiledPortDataType Simulink и CompiledPortDimensions свойства указателей на порты.

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

См. также

|

Темы

Введенный в R2020a

Simulink Report Generator

Поддержка

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