slreportgen.report.LookupTable class

Пакет: 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 свойство задать, использовать ли объемную поверхностную диаграмму или сетчатый график.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Методы

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

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

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

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

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

Примеры

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

Создайте генератор отчетов PDF, который сообщает относительно блока интерполяционной таблицы. Этот пример использует sf_car модель и отчеты относительно ее engine torque Блок Lookup Table (n-D) . Этот блок является двумерной интерполяционной таблицей. 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 Блок Lookup Table (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

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