exponenta event banner

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

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

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

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

Свойства

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

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

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

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

Путь к выходному каталогу документа.

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

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

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

  • 'both' - Создает как заархивированные, так и распакованные выходные данные

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

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

Методы

Метод

Цель

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