slreportgen.report. Класс LookupTable

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

Генератор отчетов блока интерполяционной таблицы

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

Описание

Создайте генератор отчетов блока интерполяционной таблицы Simulink®. Смотрите Свойство объекта для списка поддерживаемых блоков.

Примечание

Чтобы использовать генератор отчетов LookupTable в отчете, необходимо создать отчет с помощью класса slreportgen.report.Report.

Конструкция

rptr = LookupTable() создает пустой генератор отчетов блока LookupTable на основе шаблона по умолчанию. Используйте его свойства задать блок интерполяционной таблицы, на котором можно сообщить и задать опции отчета.

rptr = LookupTable(lutobj) создает генератор отчетов блока LookupTable для блока интерполяционной таблицы, заданного lutobj. По умолчанию генератор отчетов генерирует таблицу и график выходных значений по сравнению с точками останова и таблицу типов данных.

rptr = LookupTable(Name,Value) наборы свойства генератора отчетов LookupTable с помощью пар "имя-значение". Можно задать несколько аргументов пары "имя-значение" в любом порядке. Заключите каждое имя свойства в одинарные или двойные кавычки.

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

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

Смотрите Свойство объекта.

Свойства

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

Блок интерполяционной таблицы, чтобы сообщить относительно, заданный как путь или указатель блока.

Эти блоки интерполяционной таблицы поддерживаются.

Примечание

Если вы используете средство поиска, чтобы найти блок Lookup Table и добавить его непосредственно в отчет, этот генератор отчетов LookupTable используется, а не генератор отчетов свойства объекта Simulink.

Включать ли таблицу данных об интерполяционной таблице, заданных как логическое. Если true, отчет включает в себя таблицу, которая перечисляет выходные значения и точки останова интерполяционной таблицы.

Для 1D интерполяционной таблицы таблица данных перечисляет точки останова в первом столбце таблицы. Вторые списки столбцов соответствующие выходные значения.

Для 2D или большей интерполяционной таблицы размерности таблица данных перечисляет первый набор точек останова в первой строке таблицы. Это перечисляет второй набор точек останова в первом столбце. Вывод появляется в соответствующих ячейках таблицы. Для интерполяционных таблиц, больше, чем 2D, генератор отчетов LookupTable показывает срезы таблицы как отдельный вывод по сравнению с таблицами точки останова.

Включать ли график данных интерполяционной таблицы, заданный как логическое. Если true, отчет включает в себя график выходных значений по сравнению с точками останова блока интерполяционной таблицы.

Для 1D интерполяционной таблицы график является линейным графиком выходных значений по сравнению с точками останова.

Для 2D таблиц и срезов, график является объемной поверхностной диаграммой или сетчатым графиком выходных значений по сравнению с точками останова. Используйте свойство PlotType задать, использовать ли объемную поверхностную диаграмму или сетчатый график.

Постройте тип для 2D графика данных интерполяционной таблицы, заданного или как символьный массив ('Объемная поверхностная диаграмма' или как 'Сетчатый график') или строка ("Объемная поверхностная диаграмма" или "Сетчатый график").

Генератор отчетов данных об интерполяционной таблице, заданный как генератор отчетов BaseTable или пользовательский генератор отчетов. Генератор отчетов LookupTable использует заданный генератор отчетов, чтобы составить таблицу данных об интерполяционной таблице.

Чтобы настроить внешний вид таблицы данных об интерполяционной таблице, настройте генератор отчетов BaseTable по умолчанию или замените его на пользовательскую версию генератора отчетов BaseTable.

Чтобы настроить заголовок таблицы данных об интерполяционной таблице, задайте содержимое в свойстве Title заменяющего генератора отчетов или значения по умолчанию. Содержимое, которое вы задаете, помещается впереди заголовка по умолчанию. Если интерполяционная таблица слишком широка, чтобы соответствовать четко на странице, используйте свойство MaxCols DataReporter сгенерировать таблицу как набор срезов та подгонка четко. Чтобы определить оптимальное значение, выполните итерации устанавливания значения MaxCol и просматривания отчета.

Пример: lutable.DataReporter.Title = 'New Title'

Генератор отчетов графика данных интерполяционной таблицы, заданный как генератор отчетов Figure или пользовательский генератор отчетов. Генератор отчетов LookupTable использует заданный генератор отчетов, чтобы создать график выходных значений по сравнению с точками останова интерполяционной таблицы.

Чтобы настроить внешний вид графика данных об интерполяционной таблице, настройте генератор отчетов Figure по умолчанию или замените его на пользовательскую версию генератора отчетов Figure. Чтобы настроить заголовок графика, задайте содержимое в свойстве Caption заменяющего генератора отчетов или значения по умолчанию. Содержимое, которое вы задаете, помещается впереди заголовка по умолчанию.

Максимальное количество столбцов таблицы, чтобы отобразиться для выходных значений по сравнению с точками останова, заданными как inf или целое число. Это свойство применяется, только если свойство IncludeTable верно.

Если количество столбцов интерполяционной таблицы больше, чем значение этого свойства, данные показывают только как объемная поверхностная диаграмма. График появляется, только если свойство IncludePlot верно.

Значением по умолчанию этого свойства является inf, который заставляет генератор отчетов использовать таблицу независимо от размера массива данных интерполяционной таблицы. В зависимости от размера отображаемых данных некоторые таблицы могут быть неразборчивыми. Чтобы избежать создания неразборчивых таблиц, измените настройку по умолчанию этого свойства к меньшему значению.

Источник шаблона для этого генератора отчетов, заданного как одно из этих значений:

  • Строка или символьный массив, задающий путь файла, содержащего шаблон для этого генератора отчетов

  • Генератор отчетов или отчет, шаблон которого используется в качестве шаблона для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

  • Документ DOM или часть документа, шаблон которой используется в качестве шаблона для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

Заданный шаблон должен иметь тот же тип как отчет, к которому добавлен этот генератор отчетов. Например, для отчета Word, TemplateSrc должен быть шаблоном генератора отчетов Word. Если свойство TemplateSrc пусто, этот генератор отчетов использует шаблон генератора отчетов по умолчанию для выходного типа отчета.

Имя шаблона для этого генератора отчетов, заданного как строка или символьный массив. Шаблон для этого генератора отчетов находится в библиотеке шаблонов источника шаблона (TemplateSrc) для этого генератора отчетов.

Цель гиперссылки для этого генератора отчетов, заданного как строка или символьный массив, который задает ID цели ссылки или объект mlreportgen.dom.LinkTarget. Значение строки или символьного массива преобразовано в объект LinkTarget. Объект цели ссылки сразу предшествует содержимому этого генератора отчетов в выходном отчете.

Методы

createTemplateСоздайте шаблон генератора отчетов блока интерполяционной таблицы Simulink
customizeReporterСоздайте пользовательский класс генератора отчетов LookupTable
getClassFolderРасположение файла определения класса генератора отчетов Интерполяционной таблицы

Унаследованные методы

getImplПолучите реализацию генератора отчетов

Копировать семантику

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Примеры

Сообщите относительно блока интерполяционной таблицы

Создайте генератор отчетов PDF, который сообщает относительно блока интерполяционной таблицы. Этот пример использует модель sf_car и отчеты относительно ее Интерполяционной таблицы engine torque (n-D) блок. Этот блок является 2D интерполяционной таблицей. Блок engine torque находится в подсистеме Engine модели sf_car. Отчет, по умолчанию, включает в себя таблицу выходных значений по сравнению с точками останова, объемной поверхностной диаграммой, таблицей типов данных блока, и отмечает о возможных различиях между значениями, о которых сообщают, и значениями, полученными из симуляции.

import slreportgen.report.*
import mlreportgen.report.*

model_name = 'sf_car';
load_system(model_name) 
lutable = 'sf_car/Engine/engine torque';

rpt = slreportgen.report.Report('output','pdf');
chapter = Chapter(lutable); 
rptr = LookupTable(lutable); 
add(chapter,rptr)
add(rpt,chapter)

close(rpt) 
close_system(model_name)
rptview(rpt)

Измените высоту графика интерполяционной таблицы и ширину

Создайте генератор отчетов PDF, который задает высоту графика и ширину, возвращенную генератором отчетов LookupTable. Этот пример использует модель sf_car и отчеты относительно ее Интерполяционной таблицы Torque ratio (n-D) блок. Этот блок является 1D интерполяционной таблицей и находится в подсистеме transmission/Torque Converter модели sf_car. Чтобы установить высоту и ширину графика, используйте свойство PlotReporter. 

import slreportgen.report.*
import mlreportgen.report.*

model_name = 'sf_car';
load_system(model_name); 
lutable = 'sf_car/transmission/Torque Converter/Torque ratio';

rpt = slreportgen.report.Report('output','pdf');
chapter = Chapter(lutable); 

rptr = LookupTable(lutable);
rptr.IncludeTable = false;
add(chapter,rptr)

rptr_resized = LookupTable(lutable);
rptr_resized.IncludeTable = false;
rptr_resized.PlotReporter.Snapshot.Width = '3in';
rptr_resized.PlotReporter.Snapshot.Height = '4in';
add(chapter,rptr_resized)

add(rpt,chapter)

close(rpt) 
close_system(model_name)
rptview(rpt)

График по умолчанию на первой странице использования отчета, предопределенного, измеряя, чтобы соответствовать графику к размеру страницы.

Измененный график на второй странице отчета использует заданный 3 дюйма шириной и 4 дюйма высотой.

Найдите и сообщите относительно интерполяционных таблиц и других блоков

Создайте генератор отчетов PDF, который находит все блоки в подсистеме Engine модели sf_car. Программа генератора отчетов затем циклично выполняется через блоки и тесты, является ли блок блоком интерполяционной таблицы. Для блоков интерполяционной таблицы это использует генератор отчетов LookupTable, чтобы сообщить информацию о блоке. Для других блоков сгенерированный отчет сообщает относительно свойств блока, которые являются результатами класса BlockFinder.

import slreportgen.report.*
import slreportgen.finder.*

model_name = 'sf_car';
load_system(model_name)
subsys_name = 'sf_car/Engine';
rpt = slreportgen.report.Report;

blkfinder = BlockFinder(subsys_name);
blks = find(blkfinder);

for i=1:length(blks)
   if slreportgen.utils.isLookupTable(blks(i).Object)
      rptr = LookupTable(blks(i).Object);
      ch = Chapter(blks(i).Name);
      add(ch,rptr)
      add(rpt,ch)
   else
      ch = Chapter(blks(i).Name);
      add(ch,blks(i))
      add(rpt,ch)
   end
end

close(rpt)
close_system(model_name)
rptview(rpt)

Первая глава показывает свойства по умолчанию, о которых сообщают для блока Inport.

Пятая глава показывает вывод по умолчанию для генератора отчетов блока Lookup Table. Вывод по умолчанию является таблицей выходных значений по сравнению с таблицей точек останова, графиком и таблицей типов данных.

Настройте генератор отчетов LookupTable Вывод

Этот пример показывает, как добавить фиксированное содержимое в индивидуально настраиваемый HTML шаблон генератора отчетов LookupTable. Можно также настроить отчет интерполяционной таблицы, выведенный, отредактировав программу генератора отчетов напрямую. Преимущество настройки шаблона состоит в том, что можно снова использовать ее как основание для настройки другой программы генератора отчетов.

Шаблон и таблицы стилей для генератора отчетов LookupTable расположены в папке matlab\toolbox\shared\slreportgen\rpt\rpt\+slreportgen\+report\@LookupTable\resources\templates. Вы не должны задавать этот путь, когда вы копируете шаблон по умолчанию.

  1. Создайте копию шаблона HTML по умолчанию. В этом примере пакет шаблона сохранен как заархивированный файл с именем CustomTemplate.htmtx в текущей рабочей папке.

    import mlreportgen.report.*
import slreportgen.report.*

LookupTable.createTemplate('CustomTemplate','html');

  2. Разархивируйте пакет шаблона.

    unzipTemplate('CustomTemplate.htmtx');

    Разархивированный пакет шаблона является папкой документа, таблицы стилей и файлов изображений. В этом примере разархивированную папку файлов называют "CustomTemplate" и сохранена в текущей рабочей папке. Файл root.css, который находится в подпапке таблиц стилей, задает стили, которые управляют внешним видом и форматированием сгенерированного отчета. Файл docpart_templates.html задает дыры, которые содержат содержимое отчета, когда отчет сгенерирован.

  3. От папки CustomTemplate откройте файл docpart_templates.html в текстовом редакторе за пределами MATLAB.

    <html>
  <head>
    <meta charset="utf-8" />
    <title>Document Part Templates</title>
    <link rel="StyleSheet" href="./stylesheets/root.css" type="text/css" />
  </head>  <body>
    <dplibrary>
        
      <!-- NOTE: temporary in the template library until the -->
      <!   DOM supports a source without template name -->
      <dptemplate name="LookupTable">
         <hole id="Content">LUT_CONTENT</hole>
         <hole id="LUTDataTypes">DATA_TYPE</hole>
         <hole id="FootNoteContent">LUT_FOOTNOTE_CONTENT</hole>
      </dptemplate>
      <dptemplate name="LookupTableContent">
         <hole id="TableContent">TABLECONTENT</hole>
         <hole id="FigureContent">FIGURECONTENT</hole>
      </dptemplate>
    </dplibrary>
  </body>
</html>

  4. Чтобы добавить фиксированный текст в шаблон, поместите его в желаемое местоположение и используйте стандартную маркировку HTML. Этот пример добавляет текст, который появляется выше таблицы типов данных в сгенерированном отчете. Только фрагмент <dptemplate name="LookupTable"> файла показывают. 

          <dptemplate name="LookupTable">
         <hole id="Content">LUT_CONTENT</hole>
         <p><scan>This lookup table block contains the following 
            data types:</scan></p>
         <hole id="LUTDataTypes">DATA_TYPE</hole>
         <hole id="FootNoteContent">LUT_FOOTNOTE_CONTENT</hole>
      </dptemplate>

  5. Сохраните файл.

  6. В командной строке MATLAB архивируйте папку шаблона в пакет шаблона. В данном примере пакет шаблона заархивирован к файлу CustomTemplate.htmtx.

    zipTemplate('CustomTemplate');

  7. Чтобы использовать сохраненный шаблон для вашего отчета, задайте источник шаблона в своей программе генератора отчетов.

    lutable = LookupTable();
lutable.TemplateSrc = 'CustomTemplate';

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

| | | | | |

Темы

Введенный в R2018a

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