slreportgen.finder.ChartDiagramFinder class

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

Создайте поисковик диаграммы Stateflow

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

Описание

Находит Stateflow® чарты.

Конструкция

finder = ChartDiagramFinder(container) создает средство поиска, которое по умолчанию находит все необработанные диаграммы Stateflow в заданной container. Чтобы ограничить поиск определенными типами схем, используйте свойства этого искателя.

Примечание

Этот искатель может работать или в режиме поиска, или в итераторе. В режиме поиска используйте его find метод для возврата результатов поиска как массива результатов. В режиме итератора используйте его hasNext и next методы для возврата результатов поиска один за другим. При поиске в моделях, которые имеют много модели-ссылки, используйте режим итератора. Режим итератора закрывает модель после компиляции и поиска, в то время как режим поиска сохраняет все модели, которые он ищет, открытыми. Наличие многих открытых моделей может потреблять всю системную память и медленную генерацию отчетов. Режим итератора медленнее, чем режим поиска, поэтому используйте режим поиска для поиска моделей, которые ссылаются на несколько других моделей или нет.

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

Входные параметры

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

См. «свойство контейнера».

Свойства

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

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

  • Указатель на блок диаграммы Stateflow

  • Путь к блоку диаграммы Stateflow

  • Идентификатор диаграммы Stateflow

  • Объект диаграммы Stateflow

Глубина поиска системной схемы, заданная как inf или положительное целое число. SearchDepth задает, сколько уровней глубоко для поиска схем в контейнере схем. Для поиска по всем уровням используйте inf.

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

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

Выбор для поиска Библиотеки Simulink ссылок, заданный как логический. Если и это свойство, и IncludeMaskedSubsystems являются trueпоисковик ищет ссылки в контейнере схем как на блоки Подсистемы, так и на блоки Subsystem в библиотеках Simulink. Выполняется поиск по указанному SearchDepth и включает схемы, которые он находит в результатах поиска. Если это свойство true, но IncludeMaskedSubsystems является falseпоисковик ищет только ссылки на блоки Subsystem в библиотеках Simulink.

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

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

Варианты для поиска схем, заданные как строковый или символьный вектор. Значение по умолчанию Active. Допустимые значения:

  • All - Все варианты

  • Active - Только активные варианты

  • ActivePlusCode - Все активные варианты и варианты кода

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

Пример: finder.Properties = {'Gain','5'}

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

Примечание

The find метод finder игнорирует это свойство и оставляет все ссылки моделей открытыми. По этой причине вы не должны использовать метод find для поиска моделей со многими моделями-ссылками.

Методы

results = find(finder) находит график схемы в container определяется поиском. The finder является slreportgen.finder.ChartDiagramFinder объект. results является массивом slreportgen.finder.DiagramResult объекты, каждый из которых содержит график схему, найденную этим методом. Добавление этого массива к отчету или репортеру добавляет изображения содержащихся в нем графиков. Отчеты, в которые можно добавить results этого метода являются отчеты типа slreportgen.report.Report или другой объект, такой как slreportgen.report.Chapter репортер.

tf = hasNext(finder) определяет, содержит ли контейнер, который ищет поисковик, по крайней мере, один график. Если контейнер имеет хотя бы один график, hasNext метод ставит график в очередь как следующую диаграмму, которую next метод вернется. The hasNext затем метод возвращает true. Используйте next метод для получения этого графика. При последующих вызовах hasNext метод определяет, имеет ли контейнер график, которую next еще не извлечен. График ставится в очередь для next метод для извлечения и возвратов true. Если для извлечения больше не существует графиков, этот метод возвращает false. Чтобы постепенно искать графики в контейнере, используйте hasNext метод с next метод в цикле while.

Примечание

Если текущий результат является последним результатом в очереди поиска для текущего графика и AutoCloseModel свойство trueэтот метод закрывает текущий график перед открытием следующего графика. Хотя это увеличивает время поиска, это уменьшает потребление памяти при поиске графика, которая ссылается на многие другие графики. Если ваш график не ссылается на многие другие графики, чтобы ускорить поиск, установите AutoCloseModel свойство к false или используйте find способ.

result = next(result) возвращает следующую result поиска в очереди результатов, которую hasNext создан метод. Результат поиска содержит получившийся график. Добавление этого result объект в отчет или репортер добавляет репортер схемы для графика.

Копировать семантику

Указатель. Чтобы узнать, как классы handle влияют на операции копирования, см. раздел «Копирование объектов».

Примеры

Поиск диаграмм Stateflow

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

import mlreportgen.report.*
import slreportgen.report.*
import slreportgen.finder.*
 
model_name = 'sldemo_fuelsys';
load_system(model_name);
rpt = slreportgen.report.Report('output','pdf');

add(rpt, TitlePage('Title', sprintf('%s Charts',...
    model_name)));
add(rpt, TableOfContents);
chapter = Chapter('Root System');
add(chapter, Diagram(model_name));
add(rpt,chapter);

chapter = Chapter('Charts');
finder = ChartDiagramFinder(model_name); 
results = find(finder);
for result = results
    section = Section('Title',result.Name);
    add(section,result);
    add(chapter,section);
end
add(rpt, chapter);

close(rpt);
close_system(model_name);
rptview(rpt);

См. также

| | | | | |

Темы

Введенный в R2017b

Simulink Report Generator

Поддержка

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