Пакет: slreportgen.report
Суперклассы: slreportgen.report.Reporter
Репортер объектов шины Simulink
Создает репортер, генерирующий информацию о Simulink.Bus объект в отчете.
Примечание
Для использования отчета по объектам шины в отчете необходимо создать отчет с помощью slreportgen.report.Report класс или подкласс.
slreportgen.report.BusObject класс является handle класс.
создает пустой reporter = slreportgen.report.BusObject()slreportgen.report.BusObject репортерный объект. Настройте содержимое и форматирование информации, сообщаемой для объекта шины, с помощью свойств объекта reporter. Перед добавлением репортера в отчет необходимо задать свойству Object репортера значение slreportgen.report.ModelVariableResult или Simulink.VariableUsage объект, определяющий Simulink.Bus объект. Добавление пустого репортера в отчет приводит к ошибке.
создает репортер для reporter = slreportgen.report.BusObject(object)Simulink.Bus объект, указанный slreportgen.report.ModelVariableResult или Simulink.VariableUsage объект. См. свойство Object.
устанавливает свойства репортера, используя пары имя-значение. Можно указать несколько аргументов пары имя-значение в любом порядке. Заключите каждое имя свойства в одинарные или двойные кавычки.reporter = slreportgen.report.BusObject(Name,Value)
Object - Объект, указывающий Simulink.Bus объектslreportgen.finder.ModelVariableResult объект | Simulink.VariableUsage объектОбъект, определяющий Simulink.Bus объект для отчета, указанный как slreportgen.finder.ModelVariableResult объект или Simulink.VariableUsage объект.
Name - Наименование объекта шиныЭто свойство только для чтения содержит имя объекта шины для отчета, указанное как строковый скаляр.
ReportedBusProperties - Свойства объекта шины для отчета[] (по умолчанию) | строковый массив | массив ячеек символьных векторовСвойства объекта шины для отчета, заданные как строковый массив или массив ячеек символьных векторов. Свойства, указанные ReportedBusProperties далее фильтруются свойством PropertyFilterFcn собственность. Если ReportedBusProperties пустое свойство, репортер включает все свойства в отчет, за исключением свойств, отфильтрованных PropertyFilterFcn собственность. Репортер исключает любое свойство объекта шины, недопустимое для объекта шины.
ReportedElementProperties - Свойства элемента шины для отчета[] (по умолчанию) | строковый массив | массив ячеек символьных векторовСвойства элемента шины для отчета, заданные как строковый массив или массив ячеек символьных векторов. Свойства, указанные ReportedElementProperties далее фильтруются по функции или коду, указанному в PropertyFilterFcn собственность. Если ReportedElementProperties пустое свойство, репортер включает все свойства в отчет, за исключением свойств, отфильтрованных PropertyFilterFcn собственность. Репортер исключает любое свойство элемента шины, недопустимое для элемента шины.
ShowName - Показывать ли название шиныfalse (по умолчанию) | trueОтображать ли имя объекта шины в отчете, указанное как true или false.
ShowHierarchy - Отображать ли иерархию объекта шиныtrue (по умолчанию) | falseВключать ли вложенный список, представляющий иерархию шины, в отчет, указанный как true или false.
ShowProperties - Показывать ли свойства объекта шиныtrue (по умолчанию) | falseОтображать ли в отчете таблицу свойств объекта шины, указанную как true или false.
ShowElements - Показывать ли свойства элементов объекта шиныtrue (по умолчанию) | falseОтображать ли в отчете таблицу свойств элемента шины, указанную как true или false.
ShowUsedBy - Показывать ли блоки, использующие объект шиныtrue (по умолчанию) | falseОтображать ли список блоков, использующих объект шины, указанный как true или false. Если ShowUsedBy свойство имеет значение true, репортер включает в себя список блоков, которые используют объект шины в отчете. Если ShowUsedBySnapshot свойство также имеет значение true, репортер включает в себя снимок диаграммы для каждой родительской подсистемы, которая использует объект шины. Блоки, использующие объект шины, подсвечиваются в снимке.
ShowUsedBySnapshot - Показывать ли снимки диаграммы, подсвечивающие блоки, использующие объект шиныtrue (по умолчанию) | falseПоказывать ли снимки схемы родительских подсистем и выделять ли блоки, использующие объект шины, указанные как true или false. Если ShowUsedBySnapshot свойство имеет значение true, отчет включает снимок для каждой родительской подсистемы, которая использует объект шины. Блоки, использующие объект шины, подсвечиваются в снимке. Если родительская подсистема имеет более одного блока, использующего объект шины, репортер отображает только один снимок диаграммы, который выделяет блоки, использующие объект шины.
CreateSections - Создавать ли разделыtrue (по умолчанию) | falseСледует ли создавать отдельный раздел для каждого типа информации об объекте шины в отчете. Если CreateSections свойство имеет значение true, репортер создает mlreportgen.report.Section с заголовком для каждого из следующих типов информации:
иерархия
свойства
элементы
блоки, использующие объект шины
Если CreateSections свойство имеет значение false, репортер генерирует метки для таблиц и списков. Для таблицы репортер генерирует заголовок таблицы. Для списка репортер создает текст, предшествующий списку.
HierarchyListFormatter - Средство форматирования списка для иерархииmlreportgen.dom.UnorderedList | mlreportgen.dom.OrderedListСредство форматирования списка, которое форматирует созданную иерархию шины, указанное как mlreportgen.dom.UnorderedList объект или mlreportgen.dom.OrderedList объект. Чтобы настроить форматирование списка, измените свойства объекта списка или замените объект списка настраиваемым объектом списка, не содержащим элементов списка.
UsedByListFormatter - Средство форматирования списка для блоков, использующих объект шиныmlreportgen.dom.UnorderedList | mlreportgen.dom.OrderedListСредство форматирования списка, которое форматирует сформированный список блоков, использующих объект шины, указанный как mlreportgen.dom.UnorderedList объект или mlreportgen.dom.OrderedList объект. Чтобы настроить форматирование списка, измените свойства объекта списка или замените объект списка настраиваемым объектом списка, не содержащим элементов списка.
PropertiesTableReporter - Табличный репортер о свойствах объекта шиныmlreportgen.report.BaseTableТабличный репортер, используемый для форматирования таблицы свойств объекта шины, указанного как mlreportgen.report.BaseTable объект. Чтобы настроить внешний вид таблицы, измените свойства отчета таблицы по умолчанию или замените его настраиваемым репортером таблицы. При добавлении содержимого в Title свойства по умолчанию или настраиваемого отчета таблицы, содержимое отображается перед заголовком таблицы в созданном отчете.
ElementsTableReporter - Табличный репортер о свойствах элементов шиныmlreportgen.report.BaseTableТабличный репортер, используемый для форматирования таблицы свойств элемента шины, указанного как mlreportgen.report.BaseTable объект. Чтобы настроить внешний вид таблицы, измените свойства отчета таблицы по умолчанию или замените его настраиваемым репортером таблицы. При добавлении содержимого в Title свойства по умолчанию или настраиваемого отчета таблицы, содержимое отображается перед заголовком таблицы в созданном отчете.
HorizontalElementsTable - Отображать ли свойства элемента по горизонталиfalse (по умолчанию) | trueОтображать ли свойства горизонтально в таблице свойств элемента, указанной как true или false.
Если HorizontalElementsTable свойство имеет значение trueтаблица содержит по одному столбцу для каждого свойства. Например:

Если HorizontalElementsTable свойство имеет значение falseячейки свойств и значений в строке элемента разделяются на несколько строк. Например:

SectionReporter - Репортер секцииmlreportgen.report.SectionРепортер для форматирования разделов при CreateSections свойство имеет значение true, указано как mlreportgen.report.Section объект. Чтобы настроить внешний вид раздела, измените свойства репортера раздела по умолчанию или замените его настраиваемым репортером раздела.
PropertyFilterFcn - Функция или выражение для фильтрации свойств сообщаемой шины или элемента шины[] (по умолчанию) | дескриптор функции | строковый скалярный | символьный векторФункция или выражение для фильтрации свойств сообщаемой шины или элемента шины из отчета. Укажите функцию как дескриптор функции. Укажите выражение как строковый скалярный или символьный вектор.
Если предоставляется дескриптор функции, связанная функция должна:
Возьмем следующие аргументы:
variableName - имя переменной модели, обозначающей сообщаемый элемент шины или шины;
variableObject - Сообщение об элементе шины или шины
propertyName - Наименование свойства сообщаемого элемента шины или шины
Вернуть true для фильтрации указанного свойства из отчета или false для включения свойства в отчет.
Например, этот код предотвращает отображение HeaderFile и Description свойства объекта шины и Complexity свойство элемента шины:
import slreportgen.finder.* import slreportgen.report.* rpt = slreportgen.report.Report('busrpt','pdf'); model = load_system('sldemo_bus_arrays'); modelVariableFinder = ModelVariableFinder(model); results = find(modelVariableFinder); for result = results if isa(getVariableValue(result),'Simulink.Bus') busRptr = slreportgen.report.BusObject(result); busRptr.PropertyFilterFcn = @busPropertyFilter; % Create a Chapter chapter = mlreportgen.report.Chapter(busRptr.Name); add(chapter, busRptr); add(rpt,chapter) end end close(rpt); close_system(model); rptview(rpt); function tf = busPropertyFilter(~, variableObject,propertyName) if isa(variableObject, 'Simulink.Bus') tf = (propertyName == "HeaderFile") || ... (propertyName == "Description"); else % Filter Simulink.BusElement Complexity property tf = propertyName == "Complexity"; end end
Если предоставляется строковый скаляр или символьный вектор, он должен содержать выражение. Выражение:
Может использовать переменные variableName, variableObject, и propertyName
Необходимо задать переменную isFiltered кому true для фильтрации указанного свойства из отчета или false включение свойства в отчет
Например, этот код фильтрует HeaderFile свойство объекта шины из отчета:
import slreportgen.finder.* import slreportgen.report.* rpt = slreportgen.report.Report('busrpt','pdf'); model = load_system('sldemo_bus_arrays'); modelVariableFinder = ModelVariableFinder(model); results = find(modelVariableFinder); for result = results if isa(getVariableValue(result),'Simulink.Bus') busRptr = slreportgen.report.BusObject(result); busRptr.PropertyFilterFcn = "isFiltered = " + ... "isa(variableObject, 'Simulink.Bus') && " + ... "propertyName == 'HeaderFile';"; % Create a Chapter chapter = mlreportgen.report.Chapter(busRptr.Name); add(chapter, busRptr); add(rpt,chapter) end end close(rpt); close_system(model); rptview(rpt);
TemplateSrc - Источник шаблона для этого репортера[] (по умолчанию) | символьный вектор | строковый скаляр | репортер или отчет | документ DOM или часть документаИсточник шаблона для этого репортера, указанный одним из следующих способов:
Вектор символов или строковый скаляр, указывающий путь к файлу, содержащему шаблон для этого репортера
Репортер или отчет, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера
Документ DOM или деталь документа, шаблон которого используется для этого репортера или библиотека шаблонов которого содержит шаблон для этого репортера
Указанный шаблон должен быть того же типа, что и отчет, к которому добавлен этот репортер. Например, для отчета Microsoft ® Word :TemplateSrc должен быть шаблоном репортера Word. Если TemplateSrc пустое свойство, этот репортер использует шаблон репортера по умолчанию для типа вывода отчета.
TemplateName - Название шаблона для этого репортераИмя шаблона для этого репортера, указанного как вектор символов или скаляр строки. Шаблон для этого репортера должен находиться в библиотеке шаблонов источника шаблона (TemplateSrc) для этого репортера.
LinkTarget - Цель гиперссылки для этого репортера[] (по умолчанию) | символьный вектор | строковый скаляр | mlreportgen.dom.LinkTarget объектЦель гиперссылки для этого репортера, указанная как вектор символов или скаляр строки, указывающий идентификатор цели связи, или mlreportgen.dom.LinkTarget объект. Вектор символов или строковое скалярное значение преобразуется в LinkTarget объект. Цель ссылки непосредственно предшествует содержимому этого репортера в выходном отчете.
slreportgen.report.BusObject.createTemplate | Создание шаблона отчета по объектам шины |
slreportgen.report.BusObject.customizeReporter | Создание отчета о пользовательских объектах шины |
slreportgen.report.BusObject.getClassFolder | Расположение файла определения класса репортера объекта шины |
copy | Создание копии объекта-репортера Simulink и создание глубоких копий определенных значений свойств |
getImpl | Получить реализацию репортера |
Сообщите об объектах шины в модели с помощью поиска переменных модели, чтобы найти все переменные, используемые в модели, а затем создайте репортер шины для каждой переменной, которая является объектом шины.
% Create a Report rpt = slreportgen.report.Report("MyReport","pdf"); open(rpt); % Load a model model_name = "sldemo_bus_arrays"; load_system(model_name); % Find all variables used by the model finder = slreportgen.finder.ModelVariableFinder(model_name); % Create a Bus object reporter object for all results representing a % Simulink.Bus object while hasNext(finder) result = next(finder); if isa(getVariableValue(result), "Simulink.Bus") % Create a Bus object reporter busReporter = slreportgen.report.BusObject(result); % Create a Chapter chapter = mlreportgen.report.Chapter(busReporter.Name); % Add bus to chapter add(chapter, busReporter) % Add chapter to the report add(rpt,chapter); end end % Close and view the report close(rpt); rptview(rpt);
Настройте содержимое отчетов и форматирование содержимого, установив свойства репортера объектов шины. Этот пример использует собственность ReportedElementProperties ограничить свойства элемента, о которых сообщают. Свойство HorizontalElemityTable используется для создания таблицы свойств с одним столбцом для каждого свойства.
% Create a Report rpt = slreportgen.report.Report("MyReport","pdf"); open(rpt); % Load a model model_name = "sldemo_bus_arrays"; load_system(model_name); % Find all variables used by the model finder = slreportgen.finder.ModelVariableFinder(model_name); % Create a Bus object reporter object for all results representing a % Simulink.BusObject object while hasNext(finder) result = next(finder); if isa(getVariableValue(result), "Simulink.Bus") % Create a Bus object reporter busReporter = slreportgen.report.BusObject(result); % Limit the properties that are reported busReporter.ReportedElementProperties = {'Name','DataType','Min','Max'}; % Display element properties horizontally busReporter.HorizontalElementsTable = true; % Create a Chapter chapter = mlreportgen.report.Chapter(busReporter.Name); % Add bus to chapter add(chapter, busReporter) % Add chapter to the report add(rpt,chapter); end end % Close and view the report close(rpt); rptview(rpt);
Simulink.findVars | Simulink.VariableUsage | slreportgen.finder.ModelVariableFinder | slreportgen.finder.ModelVariableResult | slreportgen.report.Bus | slreportgen.report.ModelVariable
1. Если смысл перевода понятен, то лучше оставьте как есть и не придирайтесь к словам, синонимам и тому подобному. О вкусах не спорим.
2. Не дополняйте перевод комментариями “от себя”. В исправлении не должно появляться дополнительных смыслов и комментариев, отсутствующих в оригинале. Такие правки не получится интегрировать в алгоритме автоматического перевода.
3. Сохраняйте структуру оригинального текста - например, не разбивайте одно предложение на два.
4. Не имеет смысла однотипное исправление перевода какого-то термина во всех предложениях. Исправляйте только в одном месте. Когда Вашу правку одобрят, это исправление будет алгоритмически распространено и на другие части документации.
5. По иным вопросам, например если надо исправить заблокированное для перевода слово, обратитесь к редакторам через форму технической поддержки.