slreportgen.finder.SignalFinder class

Пакет: slreportgen.finder

Найдите сигналы используемыми моделью или блоком

Описание

Используйте объект slreportgen.finder.SignalFinder класс, чтобы найти сигналы используемыми моделью или блоком.

Сигналами являются выходные параметры динамических систем, которые представлены блоками в схеме Simulink и самой схемой. Чтобы найти уникальные сигналы в системе, средство поиска сигнала ищет выходные порты блока. Когда блок или подсистема ищутся, результаты представляют выходные порты блока или подсистемы, а также выходные порты блоков, выходные сигналы которых питаются в блок или подсистему. Когда модель ищется, результаты представляют выходные порты блоков модели Inport и выходные порты блока, которые соединяются с блоками модели Outport.

slreportgen.finder.SignalFinder классом является handle класс.

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

HandleCompatible
true

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

Создание

Описание

пример

finder = slreportgen.finder.SignalFinder(container) создает SignalFinder объект и наборы свойство Container к модели или блоку заданы container. Используйте SignalFinder свойства к:

  • Ограничьте поиск к типам найденных сигналов, такой, как введено, выведите, или внутренние сигналы.

  • Задайте количество уровней, чтобы искать в модели.

Используйте SignalFinder методы, чтобы выполнить поиск.

Примечание

Это средство поиска обеспечивает два способа получить результаты поиска:

  1. Чтобы возвратить результаты поиска как массив, используйте find метод. Добавьте результаты непосредственно в отчет или обработайте результаты в a for цикл.

  2. Чтобы выполнить итерации через результаты по одному, используйте hasNext и next методы в a while цикл.

Никакая опция не имеет преимущество эффективности.

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

Свойства

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

Модель или блок, чтобы искать сигналы в виде одного из следующих значений:

  • Строковый скаляр или вектор символов, который содержит имя модели или блока

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

Найти ли сигналы выведенными контейнерной моделью или блоком в виде true или false. Если Container модель, результаты выходного сигнала представляют выходные порты блоков, которые питаются в блоки Outport в верхнем уровне модели. Если Container блок, результаты выходного сигнала представляют выходные порты блока.

Найти ли управляющие сигналы блока в виде true или false. Это свойство применяется только когда Container блок, такой как блок Subsystem или Model, который имеет порт управления. Управляющие сигналы управляют выполнением блока. Результаты управляющего сигнала представляют выходные порты блоков, которые питаются в порт управления блока, такой как разрешение, триггер, или сбрасывают порт. Если Container модель, о любых сигналах, которые управляют выполнением блоков в модели, сообщают как внутренние сигналы.

Найти ли внутренние сигналы в виде true или false. Внутренние сигналы не используются в качестве входа, выводятся, или управляющие сигналы для модели или подсистемы. Это свойство применяется только если Container модель или подсистема. Внутренние результаты сигнала представляют выходные порты всех блоков в системе, за исключением выходных портов блоков Inport и выходных портов, которые питаются в блоки Outport.

Найти ли сигналы выведенными виртуальными блоками в виде true или false.

Если этим свойством является true, результаты сигнала могут представлять порты виртуальных блоков, такие как виртуальные блоки Subsystem.

Если этим свойством является false, результаты сигнала представляют только выходные порты невиртуальных блоков. Введите и управляющие сигналы прослеживаются до невиртуальных блоков, которые выводят сигнал. Если модель или блок заданы Container свойство является виртуальными, выходными портами модели, или блок прослеживаются до их невиртуальных источников.

Найти ли сигналы без имени в виде true или false.

Количество уровней, чтобы искать внутренние сигналы в модели или подсистеме в виде одного из этих значений:

  • 1 — Поисковый уровень один (верхний уровень) только.

  • inf — Ищите все уровни.

  • Целочисленный n, который больше одного — Поиск конкретное количество уровней. Результаты сортируются от уровня один (верхняя часть), чтобы выровнять n.

Смотрите IncludeInternalSignals.

Свойства выходных портов найти в виде массива ячеек пар "имя-значение". Средство поиска возвращает только выходные порты, которые имеют заданные свойства с заданными значениями.

Пример: {'CompiledPortDataType','int8'}

Методы

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

Примеры

свернуть все

Этот пример создает отчет, который включает информацию о сигналах в модели при помощи slreportgen.finder.SignalFinder объект. Пример устанавливает свойства средства поиска так, чтобы сигналы без имен были исключены, и включены внутренние сигналы.

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

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

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

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

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

chapter = Chapter();
chapter.Title = "Named Signals";

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

model_name = "vdp";
load_system(model_name);

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

finder = SignalFinder(model_name);
finder.IncludeUnnamedSignals = false;
finder.IncludeInternalSignals = true;

Найдите сигналы и добавьте результаты в главу.

results = find(finder);
append(chapter,results);

Добавьте главу в отчет.

append(rpt,chapter);

Закройте и просмотрите отчет.

close(rpt);
rptview(rpt);
Введенный в R2021a