mlreportgen.finder.Finder class

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

Создайте средство поиска MATLAB

Описание

mlreportgen.finder.Finder абстрактный класс объектов средства поиска найти объекты результата, которые могут быть добавлены к mlreportgen.report.Report объект. Используйте этот класс в качестве основания для создания вашего собственного класса средства поиска.

Свойства

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

Контейнер, который будет искаться средством поиска. Тип данных зависит от типа контейнера, который будет искаться. Например, для имени переменной, тип данных является вектором символов или строкой.

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

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

Методы

results = find(finder) находит элементы в контейнере заданными средством поиска. Этот метод возвращает элементы, которые он находит перенесенным в объекты результата. Эти объекты результатов могут быть добавлены непосредственно к отчетам типа mlreportgen.report.Report или slreportgen.report.Report. Можно также добавить результаты в генератор отчетов, который вы затем добавляете в отчет.

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

result = next(finder) возвращает следующий поисковый result в очереди результата, что hasNext метод создается. Этот метод возвращает элемент, который он находит, перенесенный в mlreportgen.finder.Result объект. Чтобы добавить таблицы свойств элемента, добавьте объект результата в отчет непосредственно или добавьте его в генератор отчетов, который вы затем добавляете в отчет. Отчеты, в которые можно добавить results из этого метода должен иметь тип mlreportgen.report.Report.

tf = isIterating(finder) проверки, выполняет ли средство поиска итерации, чтобы найти результаты. Если true, вы не можете изменить ни одно из свойств средства поиска.

tf = mustNotBeIterating(finder) или tf = mustNotBeIterating(finder,propertyName) подтверждает это, средство поиска не выполняет итерации, чтобы найти результаты. Если true, средство поиска не должно выполнять итерации, и можно изменить значения свойств, и т.д. Если false, средство поиска выполняет итерации, и вы не можете изменить его свойства и т.д. Дополнительный propertyName вход является свойством, которое изменяется и вызвало ошибку.

tf = satisfyObjectPropertiesConstraint(finder,obj) определяет если obj имеет свойство, которое удовлетворяет Properties ограничение задано средством поиска.

reset(finder) сбрасывает средство поиска к его начальному состоянию, такому что вызов next(finder) возвращает первый результат и сбрасывает объектные состояния.

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

Указатель. Чтобы изучить, как классы Handle влияют на операции копии, смотрите Копирование Объектов (MATLAB).

Введенный в R2018a

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