slreportgen.webview. Класс WebViewDocument

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

Создайте генератор документа веб-представления

Описание

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

Конструкция

wvdocgen = slreportgen.webview.WebViewDocument(docname,model) создает генератор документа, который генерирует документ HTML в заданном местоположении, содержащем веб-представление заданной модели. Используйте метод fill генератора, чтобы сгенерировать документ.

wvdocgen = slreportgen.webview.WebViewDocument(docname,model1,model2,...modeln)создает генератор документа, который включает две или больше модели в веб-представление, которое он создает. Этот конструктор присваивает массив объектов slreportgen.webview.ExportOptions по умолчанию к свойству ExportOptions генератора, один для каждой из моделей, которые будут включены в веб-представление сгенерированного документа. Можно использовать объекты задать пользовательские опции экспорта для моделей, которые будут экспортироваться.

wvdocgen = slreportgen.webview.WebViewDocument(docname,{model1,model2,...modeln}) присваивает объект slreportgen.webview.ExportOptions по умолчанию свойству ExportOptions генератора, которое применяется ко всем моделям, которые будут экспортироваться.

wvdocgen = slreportgen.webview.WebViewDocument(docname) создает генератор документа веб-представления для первоначально незаданной модели или набора моделей. Используйте свойство Systems свойства ExportOptions генератора задать модель или модели, которые будут включены в веб-представление, которое это генерирует.

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

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

Имя zip-файла и/или папки, содержащей отчет, сгенерировано этим генератором. Используйте свойство PackageType этого генератора задать, группировать ли сгенерированный отчет как файл или папку или обоих. Если вы задаете расширение, расширение должно be.htmx. Если вы не задаете расширение, генератор отчетов добавляет .htmx.

Имя модели Simulink, чтобы экспортировать в интерактивное Веб-представление HTML, заданное как вектор символов.

Выходные аргументы

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

Свойства

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

Идентификатор текущей дыры в документе. Это - свойство только для чтения.

Массив объектов slreportgen.webview.ExportOptions, один для каждой модели или набора моделей, которые будут экспортироваться. Конструктор генератора устанавливает это свойство со значениями по умолчанию для модели или моделей, которые вы задаете. Используйте свойства объекта ExportOptions, или возражает, чтобы настроить экспорт моделей к сгенерированному веб-представлению. Например, можно задать дополнительные модели, чтобы включать или включать ли блок-схемы подсистем маскированных и блоков библиотеки.

Перезаписать ли существующий отчет с тем же именем. True перезаписывает существующий отчет. False генерирует отчет под новым именем.

Путь документа вывел директорию.

Упаковка, чтобы использовать для выходного документа, заданного как один из этих векторов символов:

  • 'zipped' — Создает zip-файл с расширением .htmx

  • 'unzipped' — Создает папку файлов

  • 'both' — Создает и заархивированный и разархивированный вывод

Путь к шаблону HTML, чтобы использовать, чтобы сгенерировать этот отчет. Шаблон имеет расширение .htmtx. Это свойство указывает по умолчанию на шаблон по умолчанию. Чтобы использовать пользовательский шаблон, установите это свойство на путь пользовательского шаблона.

Текст, чтобы отобразиться в строке заголовка браузера HTML, отображающего сгенерированный документ веб-представления. Текст по умолчанию является “Веб-представлением Simulink - Созданный Simulink Report Generator".

Методы

Метод

Цель

fillВызывает заполняющие дыру методы генератора веб-представления (например, fillslwebview), чтобы заполнить дыры в шаблоне документа веб-представления
fillslwebviewslwebview дыра шаблона заливок с веб-представлением
getExportModelsИмена моделей, которые будут включены в веб-представление
getExportDiagramsПути и указатели блок-схем, которые будут включены в веб-представление
getExportSimulinkSubSystemsПути и указатели подсистемы блокируются, чтобы быть включенными в это веб-представление
getExportStateflowChartsПути и указатели
getExportStateflowDiagramsМассив Stateflow® схематически изображает пути

Примеры

Модель экспорта к веб-представлению

import slreportgen.webview.*
load_system('f14')
d = WebViewDocument('f14WebView', 'f14');
fill(d);
rptview(d);

close_system('f14');

Экспортируйте многоуровневые модели в веб-представление

Опции экспорта в этом примере позволяют вам просматривать подсистему, которая реализует блок Библиотеки Simulink, Ограниченный Полосой Белый шум, в модели f14 и диаграмме Stateflow, которая реализует блок Engine в модели sf_car. Если бы пример не включил опции экспорта, подсистема и график появились бы только как блоки в экспортируемом веб-представлении.

import slreportgen.webview.*
load_system('f14');
load_system('sf_car');
wvdoc = WebViewDocument(...
    'myWebview','f14','sf_car'); 
opts = wvdoc.ExportOptions;
 
f14Opts = opts(1);
f14Opts.IncludeMaskedSubsystems = true; 
f14Opts.IncludeSimulinkLibraryLinks = true;

sfcarOpts = opts(2);
sfcarOpts.IncludeMaskedSubsystems = true; 

fill(wvdoc)
rptview(wvdoc)

close_system('f14');
close_system('sf_car');

Экспортируйте выбранные системы в веб-представление

Этот пример экспортирует корневую систему f14 и подсистему Aircraft Dynamics Model .

import slreportgen.webview.*
load_system('f14');
wvdoc = WebViewDocument('myWebView', ...
    {'f14', 'f14/Aircraft Dynamics Model'});
wvdoc.ExportOptions.SearchScope = 'Current';
fill(wvdoc)
rptview(wvdoc)
close_system('f14');

Экспортируйте предков подсистемы в веб-представление

Этот пример экспортирует корневую систему f14 и подсистему Controller.

wvdoc = slreportgen.webview.WebViewDocument(...
    'mydoc', 'f14/Controller');
wvdoc.ExportOptions.SearchScope = 'CurrentAndAbove';
 
fill(wvdoc)
rptview('myWebView')

Введенный в R2017a

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