slreportgen.report.Signal class

Пакет: slreportgen.report

Репортер сигнала

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

Описание

Используйте объект slreportgen.report.Signal класс, чтобы сообщить свойства сигнала.

Сигналы являются выходами динамических систем, которые представлены блоками в схеме Simulink и самой схемой. См. «Основы сигнала».

Примечание

Как использовать Signal объект в отчете, вы должны создать отчет с помощью slreportgen.report.Report класс или подкласс.

The slreportgen.report.Signal класс является handle класс.

Атрибуты класса

HandleCompatible
true

Для получения информации об атрибутах класса см. раздел «Атрибуты класса».

Создание

Описание

reporter = slreportgen.report.Signal() создает slreportgen.report.Signal объект со значениями свойств по умолчанию. Вы должны задать сигнал для отчета, установив Object свойство. Используйте другие свойства для настройки сообщаемой информации и форматирования информации.

пример

reporter = slreportgen.report.Signal(object) устанавливает Object свойство к object.

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

Свойства

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

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

Сообщать ли информацию о Simulink.Signal объект для этого сигнала, заданный как true или false. Если это свойство true, сигнал reporter включает информацию о Simulink.Signal объект, который задает атрибуты сигнала. Свойства Simulink.Signal об объекте сообщается с помощью mlreportgen.report.MATLABVariable репортер. Используйте MATLABVariableReporter свойство этого репортера сигнала для настройки внешнего вида информации об объекте сигнала. Если сигнал не связан с объектом сигнала, ничего не сообщается.

Репортер для Simulink.Signal объект, который определяет сообщаемый сигнал, заданный как mlreportgen.report.MATLABVariable объект. Значение по умолчанию является пустым MATLABVariable репортер с DepthLimit значение свойства установлено в 0. Репортер по умолчанию сообщает информацию о Simulink.Signal объект в одной таблице. Чтобы настроить внешний вид сообщаемой информации, измените свойства MATLABVariable по умолчанию репортер или замените репортер на настроенный MATLABVariable репортер. Например, следующий код использует PropertyFilterFcn свойство MATLABVariable reporter, чтобы отобразить только определенные свойства Simulink.Signal объект:

filterFcnHandle = @(variableName, variableObject, propertyName) ...
~ismember(propertyName, ["Description", "DataType", "Unit"]);
signalRptr.MATLABVariableReporter.PropertyFilterFcn = filterFcnHandle;
Некоторые свойства сигнальных объектов, таких как CoderInfo свойство, имеют значения, которые также являются объектами со свойствами. Чтобы отобразить свойства свойств в отдельных таблицах, установите DepthLimit свойство MATLABVariableReporter к целому числу, которое больше 0. Для примера: 

signalRptr.MATLABVariableReporter.DepthLimit = 10;

Форматтер таблицы свойств сигнала, заданный как mlreportgen.report.BaseTable объект. Значение по умолчанию этого свойства является BaseTable объект со TableStyleName значение свойства установлено в SignalTable стиль, заданный в шаблоне по умолчанию для Signal репортер. Чтобы настроить внешний вид таблицы, измените свойства BaseTable по умолчанию объект или замените объект на свой собственный BaseTable объект. Если вы добавляете содержимое в Title свойство BaseTable объект, содержимое появляется перед заголовком таблицы в сгенерированном отчете.

Отображать ли свойства сигнала, которые имеют пустые значения, задается как true или false.

Свойства сигнала для отчета, заданные как строковые массивы или массив ячеек из векторов символов. Задайте любую комбинацию следующих свойств:

  • Name

  • Description

  • Source

  • Destination

  • NonvirtualDestination

  • DataType

  • Complexity

  • Dimensions

  • Min

  • Max

  • SampleTime

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

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

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

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

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

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

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

Методы

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

Примеры

свернуть все

Открыть Live Script

Использование slreportgen.report.Signal объект для включения информации о сигнале в отчет.

Импортируйте пакеты MATLAB и Simulink Report API так, чтобы вам не пришлось использовать длинные, полные имена классов.

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

Загрузите модель.

model_name = "vdp";
load_system(model_name);

Создайте отчет Simulink.

rpt = slreportgen.report.Report("signal_example","pdf");

Добавьте схему модели в отчет.

append(rpt,slreportgen.report.Diagram(model_name));

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

ph = get_param("vdp/x1","PortHandles");
port = ph.Outport;

Создайте главу для информации о сигнале.

ch = Chapter("x1");

Создайте Signal репортер для сигнала и добавьте репортер к главе.

signalRptr = slreportgen.report.Signal(port);
append(ch,signalRptr);

Добавить главу в отчет. Закройте и просмотрите отчет.

append(rpt,ch);
close(rpt);
rptview(rpt);

См. также

|

Темы

Введенный в R2021a

Simulink Report Generator

Поддержка

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