slreportgen.report.SystemHierarchy class

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

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

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

Описание

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

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

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

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

Свойства

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

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

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

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

Методы

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

Примеры

свернуть все

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

% 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 Report Generator

Поддержка

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