Exponenta Banner

slreportgen.report.ElementDiagram class

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

Снимок состояния схемы элемента и генератор отчетов заголовка

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

Описание

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

Примечание

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

Конструкция

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

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

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

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

Смотрите свойство Source.

Свойства

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

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

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

  • Обработайте к блоку блока Simulink или диаграммы Stateflow

  • Объект Stateflow

  • Идентификатор Simulink (SID) блока, аннотации или объекта Stateflow

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

Примечание

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

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

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

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

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

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

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

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

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

  • 'tif' — Пометьте формат Файла изображения, не поддержанный в выводе HTML.

  • 'pdf' — Изображение PDF.

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

Опции для масштабирования элемента диаграммы отображают в виде строки или вектора символов. Допустимые опции масштабирования:

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

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

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

Примечание

java.lang.OutOfMemoryError может произойти, когда любая из этих комбинаций настроек свойства происходит:

  • Scaling установите на zoom, и Zoom'maxHeight' , и MaxWidth набор свойств к большим значениям

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

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

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

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

МодулиМодульное сокращение
'pixels'px
'centimeters'cm
'inches'in
миллиметрыmm
цицероpc
'points'pt

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

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

getImplПолучите реализацию генератора отчетов

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

Добавьте схему элемента и заголовок

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
Поддержка