Exponenta Banner
exponenta event banner

класс slreportgen.report.SystemHierarchy

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

Репортер по иерархии системы

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

Описание

Создание отчета о системной иерархии, который создает вложенный список подсистем модели или подсистемы Simulink ® в отчете.

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

rptr = slreportgen.report.SystemHierarchy() создает пустой системный отчет по иерархии на основе шаблона по умолчанию. Настройте содержимое и формат созданного списка с помощью свойств репортера. Перед добавлением репортера в отчет необходимо указать модель или подсистему в свойстве «Источник» репортера. Добавление пустого репортера в отчет приводит к ошибке.

пример

rptr = slreportgen.report.SystemHierarchy(source) создает системный иерархический репортер для модели или подсистемы, указанной в source. См. свойство Источник.

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

Свойства

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

Модель или подсистема Simulink, заданная как строковый скалярный или символьный вектор, содержащий путь к модели или подсистеме или как дескриптор к модели или подсистеме.

Максимальное количество уровней предков исходной подсистемы, включаемых в создаваемый список, указанное как неотрицательный целочисленный скаляр. Например, если MaxAncestorLevel является 2, список включает источник и до двух уровней предков. Если MaxAncestorLevel является Inf, значение по умолчанию, список включает всех предков. Если MaxAncestorLevel равно нулю, список не включает предков.

Максимальное число уровней потомков исходной модели или подсистемы, включаемых в создаваемый список, указанное как неотрицательный целочисленный скаляр. Например, если MaxDescendantLevel является 2, список включает источник и до двух уровней потомков. Если MaxDescendantLevel является Inf, значение по умолчанию, список включает всех потомков. Если MaxDescendantLevel равно нулю, список не включает потомков.

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

Подчеркивать ли исходную модель или подсистему в созданном списке, указанном как true или false. Если EmphasizeSource является true, имя исходной модели или подсистемы отформатировано в соответствии с TextFormatter собственность. В противном случае он форматируется так же, как и другие элементы списка.

Средство форматирования списка, которое форматирует созданный список, указанный как mlreportgen.dom.UnorderedList объект или mlreportgen.dom.OrderedList объект. Чтобы настроить форматирование списка, измените свойства объекта списка или замените объект списка настраиваемым объектом списка, не содержащим элементов списка.

Объект форматирования текста, который форматирует имя исходной модели или подсистемы в созданном списке, указанный как mlreportgen.dom.Text объект. Это свойство применяется только в том случае, если EmphasizeSource свойство - true. Начальное значение SourceTextFormatter свойство является mlreportgen.dom.Text объект с Bold и Italic свойства установлены в значение true. Чтобы настроить внешний вид имени в созданном списке, измените mlreportgen.dom.Text свойства объекта или замена объекта настраиваемым mlreportgen.dom.Text объект. При добавлении текста к объекту текста по умолчанию или замены текст появляется перед именем источника в созданном отчете.

Включает ли созданный список потомков исходной системы маскированные подсистемы, указанные как true или false. Если IncludeMaskedSubsystems является true, список включает маскированные подсистемы и их дочерние подсистемы, если количество уровней ниже исходной подсистемы меньше или равно значению MaxDescendantLevel собственность.

Чтобы разрешить репортеру иерархии системы связывать маскированные подсистемы с соответствующими диаграммами в отчете, установите в репортере схемы значение MaskedSystemLinkPolicy свойство для 'system'.

Включает ли созданный список потомков исходной системы ссылочные модели, указанные как true или false. Если IncludeReferencedModels является true, список включает ссылочные модели и их дочерние подсистемы, если количество уровней ниже исходной подсистемы меньше или равно значению MaxDescendantLevel собственность.

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

  • Значение IncludeSimulinkLibraryLinks является true.

  • Подсистема не маскируется, или подсистема маскируется, и значение IncludeMaskedSubsystems свойство - true.

  • Количество уровней ниже исходной подсистемы меньше или равно значению MaxDescendantLevel собственность.

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

  • Значение IncludeUserLibraryLinks является true.

  • Подсистема не маскируется, или подсистема маскируется, и значение IncludeMaskedSubsystems свойство - true.

  • Количество уровней ниже исходной подсистемы меньше или равно значению MaxDescendantLevel собственность.

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

СтоимостьОписание
"Active"Активные варианты (по умолчанию)
"All"Все варианты
"ActivePlusCode"Активные варианты и варианты кода

Список включает варианты, только если количество уровней ниже исходной подсистемы меньше или равно значению MaxDescendantLevel собственность.

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Включить системную иерархию sldemo_fuelsys модель в отчете путем добавления slreportgen.report.SystemHierarchy репортер в программу генерации отчетов. Создание диаграмм модели путем добавления slreportgen.finder.DiagramFinder объект. Системный репортер иерархии генерирует ссылки из подсистем во вложенном списке на соответствующие диаграммы.

% Import the API packages
import slreportgen.report.*
import mlreportgen.report.*
import mlreportgen.dom.*

% Load the model
model = 'sldemo_fuelsys';
load_system(model);

% Create a report
rpt = slreportgen.report.Report('output','pdf');

% Create a chapter reporter
chapter = Chapter("System Hierarchy for the " + model + " Model");

% Create a SystemHierarchy reporter for the model
rptr = SystemHierarchy(model);

% Add the SystemHierarchy reporter to the chapter.
% Add the chapter to the report
add(chapter, rptr);
add(rpt, chapter);

% Find the diagrams for the subsystems
finder = slreportgen.finder.DiagramFinder(model);
while hasNext(finder)
    result = next(finder);
    ch = Chapter(result.Name);
    add(ch, result);
    add(rpt, ch);
end

% Close and view the output report
close(rpt);
close_system(model);
rptview(rpt);

Ниже приведена системная иерархия в созданном отчете:

Для просмотра схемы, соответствующей подсистеме, щелкните подсистему в списке.

См. также

Темы

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

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

Поддержка