slreportgen.report.SystemHierarchy class

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

Генератор отчетов системной иерархии

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

Описание

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

Примечание

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

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

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

HandleCompatible
true

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

Создание

Описание

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

пример

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

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

Свойства

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

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

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

Максимальное количество уровней потомков исходной модели или подсистемы, чтобы включать в сгенерированный список в виде неотрицательного целочисленного скаляра. Например, если MaxDescendantLevel 2, список включает источник и до двух уровней потомков. Если MaxDescendantLevel isinf, значение по умолчанию, список включает всех потомков. Если 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 или часть документа, шаблон которой используется для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

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

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

Цель гиперссылки для этого генератора отчетов в виде вектора символов или строкового скаляра, который задает ID цели ссылки или 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 Report Generator

Поддержка

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