slreportgen.report.Signal class

Пакет: 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 или часть документа, шаблон которой используется для этого генератора отчетов или чья библиотека шаблонов содержит шаблон для этого генератора отчетов

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

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

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

Методы

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

Примеры

свернуть все

Скрипт Open Live Script

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

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

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

Поддержка

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