slreportgen.report. Класс ElementDiagram

Пакет: 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.Port не являются допустимыми источниками для этого генератора отчетов.

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

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

  • 'auto' Использование формат .svg для HTML или PDF вывод. Использование формат .emf для Word вывод на Windows. Использование .png для Word вывод на Unix или Mac.

  • BMP Растровое изображение

  • GIF - формат обмена графическими данными

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

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

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

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

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

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

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

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

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

  • изменение масштаба Увеличивает или уменьшает размер изображения элемента до процентного значения, заданного свойством 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, 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)

Смотрите также

| | | | |

Темы

Введенный в R2018b

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