mlreportgen.finder. Класс средства поиска

Пакет: 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