slreportgen.webview.WebViewDocument class

Пакет: 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Вызывает заполняющие отверстие методы генератора веб-представления (e.g., fillslwebview), чтобы заполнить отверстия в шаблоне документа веб-представления
fillslwebviewslwebview отверстие шаблона заливок с веб-представлением
getExportModelsИмена моделей, которые будут включены в веб-представление
getExportDiagramsПути и указатели блок-схем, которые будут включены в веб-представление
getExportSimulinkSubSystemsПути и указатели подсистемы блокируются, чтобы быть включенными в это веб-представление
getExportStateflowChartsПути и указатели
getExportStateflowDiagramsМассив Stateflow® схематически изображает пути

Примеры

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

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

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

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

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

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

fill(wvdoc)
rptview(wvdoc);

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

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

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

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

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

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

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