H5O.visit_by_name

Посещение объектов, заданных местоположением и именем объекта

Синтаксис

[status,opdata_out] = H5O.visit_by_name(loc_id,obj_name,index_type,order,iter_func,opdata_in,lapl_id)

Описание

[status,opdata_out] = H5O.visit_by_name(loc_id,obj_name,index_type,order,iter_func,opdata_in,lapl_id) задает объект путем соединения идентификатора местоположения и имени объекта. loc_id задает файл или объект в файле и obj_name задает объект в файле с абсолютным именем или относительно loc_id. Список свойств доступа к ссылке может повлиять на результат, если задействованы ссылки.

Для установления итерации используются два параметра: index_type и order. The index_type параметр задает используемый индекс. Если ссылки в группе не были индексированы по типу индекса, они сначала сортируются по этому индексу, а затем начинается итерация; если ссылки были так индексированы, шаг сортировки не нужен, поэтому итерация может начаться быстрее. Задайте index_type как один из этих векторов символов или строковых скаляров.

'H5_INDEX_NAME'Альфа-числовой индекс по имени
'H5_INDEX_CRT_ORDER'Индекс по порядку создания

Обратите внимание, что тип индекса прошел в index_type является наилучшей настройкой усилий. Если приложение передает значение, указывающее итерацию в порядке создания и обнаруживается группа, которая не отслеживалась в порядке создания, эта группа будет итерация в альфа-числовом порядке по наименованию или порядку имен. (Порядок имен является собственным порядком, используемым библиотекой HDF5, и всегда доступен.) order задает порядок проверки объектов по индексу, указанному в index_type. Задайте order как один из этих векторов символов или строковых скаляров.

'H5_ITER_INC'Порядок возрастания
'H5_ITER_DEC'Уменьшение порядка
'H5_ITER_NATIVE'Самый быстрый доступный порядок

Функция обратного вызова iter_func должна иметь следующую подпись:

function [status,opdata_out] = iter_func(group_id,name,opdata_in)

opdata_in является пользовательским значением или структурой и передается на первый шаг итерации в iter_func opdata_in параметр. The opdata_out шага итерации образует opdata_in для следующего шага итерации. Итоговая opdata_out в конце итерации вызывающему абоненту возвращается следующим образом opdata_out.

lapl_id является списком свойств доступа к ссылке. Когда свойства доступа к ссылке по умолчанию приемлемы, 'H5P_DEFAULT' может использоваться.

status значение, возвращенное iter_func интерпретируется следующим образом.

нульПродолжается с итерацией или возвращает нулевое значение состояния вызывающему абоненту, если все представители были обработаны
положительныйОстанавливает итерацию и возвращает положительное значение состояния вызывающему абоненту
отрицательныйОстанавливает итерацию и выдает ошибку, указывающую на отказ

См. также