slreportgen.report.Bus class

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

Генератор отчетов для шин, выбранных или созданных блоками Simulink

Описание

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

Генератор отчетов шины находит, что шины сообщают путем поиска модели, подсистемы, блока или сигнала для блоков, что выбор сигнализирует от шины или сигналов объединения создать шину. Для модели или подсистемы, Bus генератор отчетов сообщает обо всех шинах, выбранных или созданных в модели или подсистеме. Для блока генератор отчетов сообщает о шине, которая выбрана или создана блоком. Для сигнала генератор отчетов сообщает обо всех шинах, выбранных или созданных блоками, которые соединяются с портом, заданным сигналом. Используйте Object свойство задать модель, подсистему, блок или сигнал, для которого можно сообщить о шинах.

По умолчанию, Bus генератор отчетов генерирует:

  • Иерархический список сигналов в шине

  • Таблица с деталями о выбранных сигналах или сигналах раньше создавала шину

  • Абзацы с деталями о шине возражают и соединенные блоки для каждого связанного с шиной найденного блока

Используйте свойства генератора отчетов настроить содержимое и внешний вид сгенерированного отчета. Например, используйте ReportedBlockType свойство задать, который типы блоков использовать при поиске шин.

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

busRptr = slreportgen.report.Bus(object) устанавливает Object свойство к object.

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

Свойства

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

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

  • Строковый скаляр или вектор символов, который содержит имя модели, блока Subsystem, блока Bus Creator, блока Bus Assignment или блока Bus Selector

Заголовок для каждой шины, о которой сообщают, в виде строкового скаляра, вектора символов, Объекта DOM или указателя на функцию. О содержимом этого свойства сообщают с каждой шиной, включенной генератором отчетов. Если это свойство пусто, ни о каком заголовке не сообщают.

Если это свойство содержит текст или указатель на функцию, который возвращает текст, текст добавляется к mlreportgen.dom.Paragraph объект со стилем BusTitleParagraph.

Если это свойство определяется функцией указатель, функция должна возвратить содержимое, которое может быть добавлено к отчету, такому как строковый скаляр, вектор символов или Объект DOM. Функция должна принять struct с этими полями:

  • PortHandle — Обработайте к входному порту или выходному порту сигнала шины. Для In Bus Element и блоков Out Bus Element в подсистеме, это поле является указателем порта подсистемы, которая соответствует блокам. Для In Bus Element и блоков Out Bus Element в верхнем уровне модели, этим полем является -1.

  • BlockName — Имя модели, о которой сообщают, Bus CreatorBus Selector, Bus Assignment или  блока Subsystem, который создает или выбирает шину, о которой сообщают, в виде строкового скаляра.

  • BlockPath — Полный путь модели, Bus CreatorBus Selector, Bus Assignment или  блока Subsystem, который создает или выбирает шину, о которой сообщают, в виде строкового скаляра.

  • BusPortString — Для шины, созданной или выбранной моделью или портом подсистемы, это поле содержит входной порт или выходной порт, соединенный с сигналом шины в виде строкового скаляра. Например, "Inport <x>". В противном случае это поле является пустой строкой (""). 

Например: busRptr.Title = @(blkInfo) blkInfo.BlockName;

Типы блоков раньше сообщали информацию шины в виде одного из этих значений:

  • "auto" — Сообщает информацию шины от Bus CreatorBus Assignment и  блоков Out Bus Element, если входом является Bus CreatorBus Assignment или блок Out Bus Element. В противном случае, сообщает информацию шины от   блоков In Bus Element и Bus Selector.

  • "all" — Сообщает информацию шины от всех поддерживаемых связанных с шиной типов блока.

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

    • BusCreator

    • BusSelector

    • BusAssignment

    • Inport

    • Outport

    Например: ["BusCreator","BusSelector"]

Для моделей или подсистем, Bus генератор отчетов сообщает информацию шины от всех блоков типов, которые задает это свойство. Для сигналов генератор отчетов сообщает информацию шины от всех блоков заданных типов, которые соединяются с сигналом (источник и место назначения). Для блоков это свойство используется только если IncludeNestedBuses свойством является true. Для Bus Selector и  блоков In Bus Element, генератор отчетов сообщает информацию шины от всех блоков заданного типа, которые соединяются с выходными сигналами блока. Для Bus CreatorBus Assignment и  блоков Out Bus Element, генератор отчетов сообщает информацию шины от всех блоков заданного типа, которые соединяются с входными сигналами блока.

Сообщить ли о вложенных шинах в виде true или false. Если этим свойством является true, генератор отчетов сообщает о связанных с шиной блоках типа, заданного ReportedBlockType это соединяется с выбранными сигналами, или с сигналами раньше создавал шину. Если этим свойством является false и Object блок, генератор отчетов сообщает только о блоке, заданном Object. Если этим свойством является false и Object сигнал, генератор отчетов сообщает только о блоках, непосредственно соединенных с сигналом.

Если Object модель или подсистема, это свойство не оказывает влияния потому что все блоки типа, заданного ReportedBlockType свойство используется, чтобы сообщить о шинах.

Сообщить ли, что иерархия шины сигнализирует для каждой шины в виде true или false. Если этим свойством является true, генератор отчетов включает список имен сигналов в шине. Для блоков, которые создают шины, список описывает иерархию сигнала выходной шины. Для блоков, которые выбирают сигналы из шин, список описывает иерархию сигнала входной шины. Если шина включает какие-либо вложенные сигналы, имена сигнала включены как вложенный список.

Генератор отчетов не включает иерархию сигнала для шин, созданных или выбранных портами ввода или вывода модели верхнего уровня.

Сообщить ли о деталях сигналов в виде true или false. Если этим свойством является true, генератор отчетов включает таблицу, описывающую сигналы, выбранные из шины или используемые, чтобы создать шину, в зависимости от типа блока.

Сообщить ли об имени Simulink.Bus объект, который сопоставлен с шиной, о которой сообщают, в виде true или false. Если этим свойством является true и шина, о которой сообщают, описана Simulink.BusObject, отчет включает в себя имя объекта шины и соединяет имя к информации об объекте шины, сообщенной в другом месте в отчете.

Генератор отчетов не включает имя объекта шины для шин, созданных или выбранных портами ввода или вывода модели верхнего уровня.

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

  • Для блоков, которые создают шины, генератор отчетов сообщает об именах блоков, соединенных с портом, который выводит полный сигнал шины.

  • Для блоков, которые выбирают сигналы шины, генератор отчетов сообщает об имени блока, от которого выводится полный сигнал шины.

  • Если IncludeBusLinks true, Bus Created или Signals Selected ссылка включена после имен блоков, которые совпадают с типами блока, заданными ReportedBlockType.

 

Генератор отчетов не включает имена связанных блоков для шин, созданных или выбранных портами ввода или вывода модели верхнего уровня.

Включать ли ссылку на шину, созданную или выбранную связанным блоком в виде true или false. Если этим свойством является true, генератор отчетов включает ссылку на информацию о шине для блоков, о которых сообщают как источник или место назначения в таблице сигнала или соединили разделы блоков. Для блоков, типы блока которых включены в ReportedBlockTypes, Bus Created или Signals Selected ссылка включена рядом с именем блока.

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

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

Свойства сообщить для сигналов, выбранных Bus Selector или In Bus Element , блокируются в виде массива строк или массива ячеек из символьных векторов. Задайте любое из этих свойств:

  • Outport

  • Name

  • DataType

  • Destination

  • Description

  • Complexity

  • Dimensions

  • Min

  • Max

Свойства сообщить для сигналов раньше создавали шину Bus Creator, Bus Assignment и блоками Out Bus Element в виде массива строк или массива ячеек из символьных векторов. Задайте любое из этих свойств:

  • Inport

  • Name

  • DataType

  • Source

  • Description

  • Complexity

  • Dimensions

  • Min

  • Max

Показать ли пустые столбцы в таблице сигнала в виде true или false.

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

Если TaskFilterFcn пусто, все задачи включены в отчет.

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

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

    • portHandle — Обработайте к порту выбранного сигнала, или сигнал раньше создавал шину.

    • parentPath — Полный путь родительского блока раньше сообщал информацию шины в виде строкового скаляра.

    • sourcePath — Полный путь исходного блока сигнала в виде строкового скаляра.

    • destinationPath— Полный путь целевого блока сигнала. Если существует несколько мест назначения, этот аргумент является массивом строк целевых блоков.

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

Например, этот код использует SignalFilterFcn свойство отфильтровать сигналы, которые питаются в Display3 блок:

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


model_name = "sldemo_bus_arrays";
load_system(model_name);
rpt = slreportgen.report.Report("Bus_example","pdf");

append(rpt,slreportgen.report.Diagram(model_name));

ch = Chapter("Buses");

busRptr = Bus(model_name);
busRptr.SignalFilterFcn = @(~, ~, ~, destinationPath) endsWith(destinationPath,"Display3");

append(ch,busRptr);
append(rpt,ch);
close(rpt);
rptview(rpt);

Если вы обеспечиваете строковый скаляр или вектор символов, это должно содержать выражение. Выражение:

  • Может использовать переменные portHandle, parentPath, sourcePath, и destinationPath

  • Должен установить переменную isFiltered к true отфильтровать заданную задачу из отчета или false включать задачу в отчет

Например, этот код использует SignalFilterFcn свойство отфильтровать сигналы, которые питаются в Display4 блок:

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


model_name = "sldemo_bus_arrays";
load_system(model_name);
rpt = slreportgen.report.Report("Bus_example","pdf");

append(rpt,slreportgen.report.Diagram(model_name));

ch = Chapter("Buses");

busRptr = Bus(model_name);
filterStr = "isFiltered = endsWith(destinationPath,""Display4"");";
busRptr.SignalFilterFcn = filterStr;

append(ch,busRptr);
append(rpt,ch);
close(rpt);
rptview(rpt);

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

Средство форматирования для иерархии сигнала перечисляет в виде mlreportgen.dom.OrderedList или mlreportgen.dom.UnorderedList объект. Отчеты средства форматирования и форматы список иерархий сигнала, если ShowSignalHierarchy свойство этого Bus генератором отчетов является true. OrderedList или UnorderedList объект не должен содержать элементы списка.

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

Средство форматирования абзаца, чтобы сообщить и отформатировать связанные блоки и соединить шиной сведения объекта в виде mlreportgen.dom.Paragraph объект. Значением по умолчанию этого свойства является mlreportgen.dom.Paragraph объект с StyleName набор свойств к BusParagraph разработайте, который задан в шаблоне по умолчанию для Bus генератор отчетов. Чтобы настроить внешний вид абзаца, измените свойства mlreportgen.dom.Paragraph по умолчанию возразите или замените объект на индивидуально настраиваемый mlreportgen.dom.Paragraph объект. Если вы добавляете содержимое в значение по умолчанию или заменяющий объект абзаца, содержимое появляется перед содержимым, о котором сообщают для связанных блоков и сведений объекта шины в сгенерированном отчете.

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Используйте slreportgen.report.Bus возразите, чтобы сообщить относительно шин, которые выбраны блоками в модели.

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

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

Загрузите модель.

model_name = "sldemo_bus_arrays";
load_system(model_name);

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

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

Добавьте схему модели к отчету.

append(rpt,slreportgen.report.Diagram(model_name));

Сообщите информацию шины для модели в главе.

ch = Chapter("Buses");
busRptr = Bus(model_name);

Используйте имя блока в качестве заголовка для каждой шины блока.

busRptr.Title = @(blkInfo) blkInfo.BlockName;

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

append(ch,busRptr);

Добавьте главу в отчет.

append(rpt,ch);
close(rpt);
rptview(rpt);
Введенный в R2021a