slreportgen.report.ElementDiagram class

Пакет: slreportgen.report

Моментальный снимок схемы элемента и репортер заголовка

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

Описание

Создайте Simulink® или Stateflow® репортер диаграммы элемента. При добавлении к отчету ElementDiagram reporter создает моментальный снимок элемента. Репортер добавляет снимок в отчет в виде изображения с подписью. Используйте свойство Source, чтобы задать требуемый элемент.

Примечание

Как использовать ElementDiagram репортер в отчете, вы должны создать отчет с помощью slreportgen.report.Report класс.

Конструкция

diagram = ElementDiagram() создает пустой репортер схемы элемента. Установите его свойства, чтобы захватить снимок элемента Simulink или Stateflow.

diagram = ElementDiagram(source) создает репортер схемы для элемента массива блока или графика, заданной source. Добавление этого репортера к отчету создает моментальный снимок схемы элемента и добавляет моментальный снимок с подписью к отчету. Файл изображения снимка хранится во временной папке отчета. Когда отчет закроется, файл изображения копируется в отчет и временная папка удаляется. Чтобы предотвратить удаление, используйте Debug свойство отчета. См. mlreportgen.report.Report.

Входные параметры

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

См. свойство Source.

Свойства

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

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

  • Вектор символов или строковый скаляр, который содержит путь к блоку Simulink или блоку диаграммы Stateflow

  • Указатель на блок Simulink или блок диаграммы Stateflow

  • Объект Stateflow

  • Simulink Identifier (SID) объекта блока, аннотации или Stateflow

  • slreportgen.finder.DiagramElementResult объект

Примечание

Simulink.Port объекты не являются допустимыми источниками для этого репортера.

Репортер моментального снимка, заданный по умолчанию как объект mlreportgen.report.FormalImage класс. Вам не нужно устанавливать это свойство самостоятельно. The FormalImage объект добавляет моментальный снимок схемы элемента в отчет. Чтобы контролировать размер моментального снимка, установите его mlreportgen.report.FormalImage свойства.

Формат изображения снимка, заданный как вектор символов или строковый скаляр. Поддерживаемые форматы:

  • 'bmp' - Растровое изображение.

  • 'gif' - Формат графического обмена.

  • 'jpg' - изображение JPEG.

  • 'png' - Изображение PNG.

  • 'emf' - Расширенный метафайл, поддерживаемый только в DOCX выходных данных в Windows® платформы.

  • 'svg' - Масштабируемая векторная графика.

  • 'tif' - Тег Image File формат, не поддерживается в HTML выходных данных.

  • 'pdf' - PDF.

См. Вопросы совместимости.

Опции для масштабирования изображения элемента схемы, заданные как строковый или символьный вектор. Допустимые опции масштабирования:

  • auto - Для PDF или Word (docx) выход, auto масштабирует изображение элемента так, чтобы оно помещалось на странице, сохраняя при этом соотношение сторон. Во-первых, изображение элемента масштабируется до ширины страницы. Если высота изображения превышает высоту страницы, изображение снова масштабируется. Это дополнительное масштабирование гарантирует, что изображение соответствует текущей странице с запасом 1 ". Поле позволяет пространство для подписи. Масштабирование не применяется к выходным данным HTML.

  • custom - Устанавливает высоту и ширину изображения элемента равными значениям Height этого репортера и Width свойства.

  • zoom - Увеличивает или уменьшает размер изображения элемента до процентного значения, заданного в Zoom этого репортера свойство. Чтобы задать максимальную высоту изображения и максимальную ширину изображения, используйте MaxHeight и MaxWidth свойства, соответственно.

Примечание

A java.lang.OutOfMemoryError может возникнуть при возникновении любой из следующих комбинаций настроек свойств:

  • Scaling установлено на zoom, и Zoom, MaxHeight, и MaxWidth свойства, установленные на большие значения

  • Scaling установлено на custom, и Height и Width свойства, установленные на большие значения

Чтобы избежать этой ошибки, для масштабирования Scaling, используйте меньшие Zoom, MaxHeight, и MaxWidth значения свойств. Для пользовательских Scaling, используйте меньшие Height и Width значения свойств. Использование меньших значений гарантирует, что схема помещается на странице.

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

The Height формат valueUnits, где Units - сокращение для модулей измерения высоты, а value - количество модулей. В таблице показаны допустимые сокращения Units.

МодулиМодули измерения
пикселиpx
сантиметрыcm
дюймыin
миллиметрыmm
цицероpc
точкиpt

Ширина для задания изображения элемента схемы, заданная как строка. Это свойство применяется только в том случае, если Scaling этого репортера для свойства задано значение custom.

The Width формат valueUnits, где Units - сокращение для модулей измерения высоты, а value - количество модулей. Смотрите Height свойство для таблицы допустимых сокращений Units.

Величина масштабирования изображения элемента схемы, заданная как строка. The Zoom формат value%, где value - процент, на который увеличивается или уменьшается изображение элемента схемы.

Максимальная высота масштабирования в виде строки. Это свойство применяется только в том случае, если Scaling этого репортера для свойства задано значение zoom. The MaxHeight формат valueUnits, где Units - сокращение для модулей измерения высоты, а value - количество модулей. Смотрите Height этого репортера свойство для таблицы допустимых сокращений Units.

Максимальная ширина для масштабирования, заданная как строка. Это свойство применяется только в том случае, если Scaling этого репортера для свойства задано значение zoom. The MaxWidth формат valueUnits, где Units - сокращение для модулей измерения высоты, а value - количество модулей. Смотрите Height этого репортера свойство для таблицы допустимых сокращений Units.

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

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

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

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

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

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

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

Методы

createTemplate Создайте шаблон схемы элемента
customizeReporter Создайте пользовательский класс reporter схемы элемента
getClassFolder Расположение файла определения класса схемы элемента
getSnapshotImage Расположение файла изображения моментального снимка схемы элемента

Унаследованные методы

copyСоздайте копию объекта-репортера Simulink и сделайте глубокие копии определенных значений свойств
getImplПолучите реализацию reporter

Примеры

Добавление схемы и подписи к элементу

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

load_system('f14')

rpt = slreportgen.report.Report("output","pdf");
open(rpt)
chap = Chapter();
chap.Title = "Element Diagram Reporter Example";

diag = ElementDiagram("f14/Actuator Model");
diag.Snapshot.Caption = "f14 Simulink Model - Actuator Model block";

add(chap,diag)
add(rpt,chap)

close(rpt)
rptview(rpt)

Добавление диаграмм элемента и таблиц свойств

load_system('f14')
modelsys = "f14/Aircraft Dynamics Model";

rpt = slreportgen.report.Report("output","pdf");
open(rpt)
chapter = mlreportgen.report.Chapter();
chapter.Title = "Element Snapshots";

diag = slreportgen.report.ElementDiagram(modelsys);
add (chapter,diag)

blkfinder = slreportgen.finder.BlockFinder(modelsys);
blks = find(blkfinder);
for blk = blks
   blkDiag = slreportgen.report.ElementDiagram...
       (blk.Object);
   blkDiag.Snapshot.Caption = strcat(blk.DiagramPath,...
       "/", blk.Name);
   add(chapter,blkDiag)   % Add diagram element image
   add(chapter,blk)       % Add property table
end

add(rpt,chapter)
close(rpt)
rptview(rpt)

Вопросы совместимости

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

Поведение изменено в R2019b

См. также

| | | | |

Темы

Введенный в R2018b

Simulink Report Generator

Поддержка

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