slreportgen.finder.ChartDiagramFinder class

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

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

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

Описание

Находит графики Stateflow®.

Конструкция

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

Примечание

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

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

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

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

Свойство See Container.

Свойства

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

Стройте диаграмму контейнера, в котором можно искать в виде одного из этих значений:

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

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

  • ID диаграммы 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 метод средства поиска закрывает в настоящее время открытую модель прежде, чем переместиться в следующую модель, чтобы искать. Закрытие моделей предотвращает чрезмерное потребление памяти при поиске модели, это ссылается на многие модели.

Примечание

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

Методы

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

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

Примечание

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

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

Примеры

Найдите диаграммы 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

Поддержка

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