Exponenta Banner
exponenta event banner

slreportgen.report.Класс сигнала

Пакет: slreportgen.report

Сигнальный репортер

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

Описание

Использование объекта slreportgen.report.Signal для сообщения о свойствах сигнала.

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

Примечание

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

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, сигнальный репортер включает в себя информацию о Simulink.Signal объект, определяющий атрибуты сигнала. Свойства Simulink.Signal объект сообщается с помощью mlreportgen.report.MATLABVariable репортер. Используйте MATLABVariableReporter свойство этого сигнального репортера для настройки внешнего вида информации об объекте сигнала. Если сигнал не связан с объектом сигнала, ничего не сообщается.

Репортер для Simulink.Signal объект, определяющий сообщаемый сигнал, указанный как mlreportgen.report.MATLABVariable объект. Значение по умолчанию - пустое MATLABVariable репортер с DepthLimit свойство имеет значение 0. Репортер по умолчанию сообщает информацию о Simulink.Signal в одной таблице. Чтобы настроить внешний вид сообщаемой информации, измените свойства по умолчанию MATLABVariable репортер или заменить репортер настраиваемым MATLABVariable репортер. Например, следующий код использует PropertyFilterFcn имущества MATLABVariable для отображения только определенных свойств 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 ® Word :TemplateSrc должен быть шаблоном репортера Word. Если TemplateSrc пустое свойство, этот репортер использует шаблон репортера по умолчанию для типа вывода отчета.

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

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

Методы

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

Примеры

свернуть все

Открыть сценарий в реальном времени

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

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

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

Поддержка