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 этого генератора свойство, чтобы указать, упаковать ли сгенерированный отчет как файл, или папку, или и то, и другое. Если вы задаете расширение, то расширение должно быть .htmx. Если вы не задаете расширение, генератор отчетов добавляет .htmx.

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

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

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

Свойства

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

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

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

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

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

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

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

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

  • 'both' - Создает как zipped, так и unzipped выход

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

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

Методы

Метод

Цель

fillВызывает методы заполнения отверстий генератора веб-представления (например, fillslwebview), чтобы заполнить отверстия в шаблоне документа веб-представления
fillslwebviewЗаполняет отверстие slwebview шаблона веб-представления
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