slreportgen.report.LookupTable класс

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

Репортер блоков таблицы подстановки

Описание

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

Примечание

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

Строительство

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

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

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

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

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

`lutobj` - Объект блока таблицы подстановки
путь | дескриптор

См. свойство Object.

Свойства

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

`Object` - Блок таблицы подстановки
путь | дескриптор

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

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

Примечание

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

`IncludeTable` - Включить таблицу данных таблицы подстановки
`true` (по умолчанию) | `false`

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

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

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

`IncludePlot` - Включить график данных таблицы поиска
`true` (по умолчанию) | `false`

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

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

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

`PlotType` - Тип сюжета для 2-го графика данных справочной таблицы
`'Surface Plot'` (по умолчанию) | `'Mesh Plot'`

Тип графика для графика данных таблицы поиска 2-D, указанный как символьный массив («График поверхности» или «График сетки») или строка («График поверхности» или «График сетки»).

`DataReporter` - Репортер данных таблицы подстановки
`BaseTable` reporter (по умолчанию) | пользовательский репортер

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

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

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

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

`PlotReporter` - Репортер о печати данных таблицы поиска
`Figure` reporter (по умолчанию) | пользовательский репортер

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

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

`MaxTableColumns` - Максимальное количество отображаемых столбцов таблицы
`inf` (по умолчанию) | целое число

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

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

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

`TemplateSrc` - Источник шаблона для этого репортера
`[]` (по умолчанию) | символьный вектор | строковый скаляр | репортер или отчет | документ DOM или часть документа

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

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

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

`TemplateName` - Название шаблона для этого репортера
вектор символов | строковый скаляр

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

`LinkTarget` - Цель гиперссылки для этого репортера
`[]` (по умолчанию) | символьный вектор | строковый скаляр | `mlreportgen.dom.LinkTarget` объект

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

Методы

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

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

`copy`	Создание копии объекта-репортера Simulink и создание глубоких копий определенных значений свойств
`getImpl`	Получить реализацию репортера

Примеры

Отчет о блоке таблицы подстановки

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

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

model_name = 'slrgex_sf_car';
load_system(model_name); 
lutable = 'slrgex_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 репортер. В этом примере используется slrgex_sf_car модель и отчеты о ней Torque ratio Блок таблицы подстановки (n-D). Этот блок является 1-D таблицей подстановки и находится в transmission/Torque Converter подсистема slrgex_sf_car модель. Чтобы задать высоту и ширину графика, используйте PlotReporter собственность.

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

model_name = 'slrgex_sf_car';
load_system(model_name); 
lutable = 'slrgex_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 «width и 4» height.

Поиск и создание отчетов по таблицам подстановки и другим блокам

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

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

model_name = 'slrgex_sf_car';
load_system(model_name)
subsys_name = 'slrgex_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.

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

Настройка выходных данных LookupTable Reporter

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

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

Создайте копию шаблона HTML по умолчанию. В этом примере пакет шаблона сохраняется как ZIP-файл с именем CustomTemplate.htmtx в текущей рабочей папке.
```
import mlreportgen.report.*
import slreportgen.report.*

LookupTable.createTemplate('CustomTemplate','html');
```
Распакуйте пакет шаблонов.
```
unzipTemplate('CustomTemplate.htmtx');
```
Распакованный пакет шаблонов представляет собой папку с файлами документов, таблиц стилей и изображений. В этом примере распакованная папка файлов называется «CustomTemplate» и сохраняется в текущей рабочей папке. root.css файл, который находится во вложенной папке таблиц стилей, определяет стили, которые управляют внешним видом и форматированием создаваемого отчета. docpart_templates.html в файле указываются отверстия, содержащие содержимое отчета при его создании.

От 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>

Чтобы добавить фиксированный текст в шаблон, поместите его в нужное место и используйте стандартные теги 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>
```
Сохраните файл.
В командной строке MATLAB скопируйте папку шаблона в пакет шаблонов. В этом примере пакет шаблона заносится в CustomTemplate.htmtx файл.
```
zipTemplate('CustomTemplate');
```
Чтобы использовать сохраненный шаблон для отчета, укажите источник шаблона в программе генератора отчетов.
```
lutable = LookupTable();
lutable.TemplateSrc = 'CustomTemplate';
```

См. также

Темы

Представлен в R2018a

Документация

slreportgen.report.LookupTable класс

Описание

Строительство

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

`lutobj` - Объект блока таблицы подстановки
путь | дескриптор

Свойства

`Object` - Блок таблицы подстановки
путь | дескриптор

`IncludeTable` - Включить таблицу данных таблицы подстановки
`true` (по умолчанию) | `false`

`IncludePlot` - Включить график данных таблицы поиска
`true` (по умолчанию) | `false`

`PlotType` - Тип сюжета для 2-го графика данных справочной таблицы
`'Surface Plot'` (по умолчанию) | `'Mesh Plot'`

`DataReporter` - Репортер данных таблицы подстановки
`BaseTable` reporter (по умолчанию) | пользовательский репортер

`PlotReporter` - Репортер о печати данных таблицы поиска
`Figure` reporter (по умолчанию) | пользовательский репортер

`MaxTableColumns` - Максимальное количество отображаемых столбцов таблицы
`inf` (по умолчанию) | целое число

`TemplateSrc` - Источник шаблона для этого репортера
`[]` (по умолчанию) | символьный вектор | строковый скаляр | репортер или отчет | документ DOM или часть документа

`TemplateName` - Название шаблона для этого репортера
вектор символов | строковый скаляр

`LinkTarget` - Цель гиперссылки для этого репортера
`[]` (по умолчанию) | символьный вектор | строковый скаляр | `mlreportgen.dom.LinkTarget` объект

Методы

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

Примеры

Отчет о блоке таблицы подстановки

Изменение высоты и ширины печати таблицы подстановки

Поиск и создание отчетов по таблицам подстановки и другим блокам

Настройка выходных данных LookupTable Reporter

См. также

Темы

Документация по генератору отчетов Simulink

Поддержка

Документация

slreportgen.report.LookupTable класс

Описание

Строительство

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

lutobj - Объект блока таблицы подстановки путь | дескриптор

Свойства

Object - Блок таблицы подстановки путь | дескриптор

IncludeTable - Включить таблицу данных таблицы подстановки true (по умолчанию) | false

IncludePlot - Включить график данных таблицы поиска true (по умолчанию) | false

PlotType - Тип сюжета для 2-го графика данных справочной таблицы 'Surface Plot' (по умолчанию) | 'Mesh Plot'

DataReporter - Репортер данных таблицы подстановки BaseTable reporter (по умолчанию) | пользовательский репортер

PlotReporter - Репортер о печати данных таблицы поиска Figure reporter (по умолчанию) | пользовательский репортер

MaxTableColumns - Максимальное количество отображаемых столбцов таблицы inf (по умолчанию) | целое число

TemplateSrc - Источник шаблона для этого репортера [] (по умолчанию) | символьный вектор | строковый скаляр | репортер или отчет | документ DOM или часть документа

TemplateName - Название шаблона для этого репортера вектор символов | строковый скаляр

LinkTarget - Цель гиперссылки для этого репортера [] (по умолчанию) | символьный вектор | строковый скаляр | mlreportgen.dom.LinkTarget объект

Методы

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

Примеры

Отчет о блоке таблицы подстановки

Изменение высоты и ширины печати таблицы подстановки

Поиск и создание отчетов по таблицам подстановки и другим блокам

Настройка выходных данных LookupTable Reporter

См. также

Темы

Документация по генератору отчетов Simulink

Поддержка

`lutobj` - Объект блока таблицы подстановки
путь | дескриптор

`Object` - Блок таблицы подстановки
путь | дескриптор

`IncludeTable` - Включить таблицу данных таблицы подстановки
`true` (по умолчанию) | `false`

`IncludePlot` - Включить график данных таблицы поиска
`true` (по умолчанию) | `false`

`PlotType` - Тип сюжета для 2-го графика данных справочной таблицы
`'Surface Plot'` (по умолчанию) | `'Mesh Plot'`

`DataReporter` - Репортер данных таблицы подстановки
`BaseTable` reporter (по умолчанию) | пользовательский репортер

`PlotReporter` - Репортер о печати данных таблицы поиска
`Figure` reporter (по умолчанию) | пользовательский репортер

`MaxTableColumns` - Максимальное количество отображаемых столбцов таблицы
`inf` (по умолчанию) | целое число

`TemplateSrc` - Источник шаблона для этого репортера
`[]` (по умолчанию) | символьный вектор | строковый скаляр | репортер или отчет | документ DOM или часть документа

`TemplateName` - Название шаблона для этого репортера
вектор символов | строковый скаляр

`LinkTarget` - Цель гиперссылки для этого репортера
`[]` (по умолчанию) | символьный вектор | строковый скаляр | `mlreportgen.dom.LinkTarget` объект