Функции
H5L.copy
Скопируйте ссылку от исходного местоположения до целевого местоположения
H5L.copy(srcID,srcname,destID,destname,lcplID,laplID) копирует ссылку, заданную srcname из файла или группы, заданной srcID к целевому destID. Новая копия ссылки создается с именем destname.
Детали
Входные параметры
srcID — Группа или идентификатор файла исходной ссылки.
srcname — Имя источника соединяется в файле или группе.
destID — Идентификатор текущего файла или группы в текущем файле. Если destID идентификатор файла, H5L.copy копия помещается в корневую группу файла.
destname — Имя копии ссылки.
lcplID — Соедините идентификатор списка свойств создания.
laplID — Соедините идентификатор списка свойств доступа.
H5L.create_external
Создайте гибкую ссылку на внешний объект
H5L.create_external(filename,objname,linkID,linkname,lcplID,laplID) создает гибкую ссылку на объект в различном файле.
Детали
Входные параметры
filename — Конечный файл, содержащий целевой объект.
objname — Путь к целевому объекту в том файле. objname аргумент должен запуститься в корневой группе файла, но не интерпретирован до времени поиска.
linkID — Файл или идентификатор группы новой ссылки.
linkname — Имя новой ссылки, и интерпретировано относительно linkID.
lcplID — Соедините идентификатор списка свойств создания, сопоставленный с новой ссылкой.
laplID — Соедините идентификатор списка свойств доступа, сопоставленный с новой ссылкой.
H5L.create_hard
Создайте жесткую ссылку
H5L.create_hard(objID,objname,linkID,linkname,lcplID,laplID) создает новую жесткую ссылку на существующий ранее объект в файле HDF5. Новая ссылка может быть одним из многих что точка к тому объекту.
Детали
Входные параметры
objID — Идентификатор целевого объекта, объекта, на который указывает новая жесткая ссылка.
objname — Имя целевого объекта, объекта, на который указывает новая жесткая ссылка.
linkID — Файл или идентификатор группы новой ссылки.
linkname — Имя новой ссылки, и интерпретировано относительно linkID.
lcplID — Соедините идентификатор списка свойств создания, сопоставленный с новой ссылкой.
laplID — Соедините идентификатор списка свойств доступа, сопоставленный с новой ссылкой.
H5L.create_soft
Создайте гибкую ссылку
H5L.create_soft(targetPath,linkID,linkname,lcplID,laplID) создает новую гибкую ссылку на объект в файле HDF5. Новая ссылка может быть одним из многих что точка к тому объекту i.e., объект, на который указывает новая гибкая ссылка.
Детали
Входные параметры
targetPath — Путь к целевому объекту, объект, на который указывает новая гибкая ссылка. targetPath может быть что-либо и интерпретировано во время поиска. Этот targetPath может быть абсолютным в файле или относительно linkID.
linkID — Файл или идентификатор группы новой ссылки.
linkname — Имя новой ссылки, и интерпретировано относительно linkID.
lcplID — Соедините идентификатор списка свойств создания, сопоставленный с новой ссылкой.
laplID — Соедините идентификатор списка свойств доступа, сопоставленный с новой ссылкой.
H5L.delete
Удалите ссылку
H5L.delete(locID,name,laplID) удаляет ссылку, заданную name от местоположения locID на основе идентификатора списка свойств доступа к ссылке, заданного laplID.
H5L.exists
Определите, существует ли ссылка
tf = H5L.exists(locID,linkname,laplID) проверки, если ссылка, заданная соединением идентификатора объекта и имени, существует в группе, на основе идентификатора списка свойств доступа к ссылке, заданного laplID.
H5L.get_info
Информация о ссылке
linkStruct = H5L.get_info(locID,linkname,laplID) возвращает информацию о ссылке. Файл или идентификатор группы, locID, задает местоположение ссылки. linkname аргумент, интерпретированный относительно linkID, задает запрашиваемую ссылку.
H5L.get_name_by_idx
Информация о ссылке указана индексом
name = H5L.get_name_by_idx(locID,groupname,idxtype,order,n,laplID) получает информацию о ссылке в индексе n существующий в группе groupname в местоположении groupID.
name = H5L.get_name_by_idx(locID,groupname,idxtype,order,n,laplID,'TextEncoding',encoding) дополнительно задает текстовое кодирование, чтобы использовать, чтобы интерпретировать имя ссылки.
Детали
Входные параметры
locID — Идентификатор группы.
groupname — Имя группы.
idxtype — Тип индекса в виде одного из этих векторов символов или строковых скаляров:
order — Индексируйте пересекающийся порядок в виде одного из этих векторов символов или строковых скаляров:
'H5_ITER_INC' — Итерация с начала до конца.
'H5_ITER_DEC' — Итерация от конца до начала.
'H5_ITER_NATIVE' — Итерация в самом быстром доступном порядке.
n— Соединитесь, для которого можно получить информацию.
laplID — Соедините идентификатор списка свойств доступа для запроса группы.
encoding — Текстовое кодирование в виде одного из этих значений:
'UTF-8' — Используйте кодирование системного значения по умолчанию, чтобы интерпретировать имя ссылки.
'system' — Используйте UTF-8, кодирующий, чтобы интерпретировать имя ссылки.
H5L.get_val
Значение символьной ссылки
linkval = H5L.get_val(linklocID,linkname,laplID) возвращает значение символьной ссылки. Эта функция соответствует H5L.get_val и H5Lunpack_elink_val функции в HDF5 1.8 C API.
linkval = H5L.get_val(linklocID,linkname,laplID,'TextEncoding',encoding) дополнительно задает текстовое кодирование, чтобы использовать, чтобы интерпретировать значение ссылки.
Детали
Входные параметры
linklocID — Файл или идентификатор группы.
linkname — Имя символьной ссылки и задано относительно linklocID. Символьные ссылки могут быть гибкими ссылками, внешними ссылками или определенными пользовательскими ссылками. В случае гибких ссылок, linkval массив ячеек, содержащий путь, на который указывает ссылка. В случае внешних ссылок, linkval массив ячеек, состоящий из имени конечного файла и имени объекта.
laplID — Соедините идентификатор списка свойств доступа.
encoding — Текстовое кодирование в виде одного из этих значений:
'UTF-8' — Используйте кодирование системного значения по умолчанию, чтобы интерпретировать значение ссылки.
'system' — Используйте UTF-8, кодирующий, чтобы интерпретировать значение ссылки.
Выходные аргументы
linkval — Значение символьной ссылки. В случае гибких ссылок, linkval массив ячеек, содержащий путь, на который указывает ссылка. В случае внешних ссылок, linkval массив ячеек, состоящий из имени конечного файла и имени объекта.
H5L.iterate
Выполните итерации по ссылкам
[status,idxOut,opdataOut] = H5L.iterate(groupID,idxtype,order,idxIn,fnc,opdataIn) выполняет итерации через ссылки в группе, заданной groupID, выполнять общую функцию, указателем на функцию которой является fncH5L.iterate рекурсивно не переходит по ссылкам в подгруппы заданной группы.
Детали
Входные параметры
groupID — Идентификатор группы.
idxtype — Тип индекса. Если ссылки не были индексированы типом индекса, они будут сначала отсортированы по тому индексу затем, итерация начнется. Если ссылки были так индексированы, шаг сортировки будет ненужным, таким образом, итерация сможет начаться более быстро. Задайте idxtype как один из этих векторов символов или строковых скаляров:
order — Индексируйте пересекающийся порядок в виде одного из этих векторов символов или строковых скаляров:
'H5_ITER_INC' — Итерация с начала до конца.
'H5_ITER_DEC' — Итерация от конца до начала.
'H5_ITER_NATIVE' — Итерация в самом быстром доступном порядке.
idxIn — Начальная точка итерации.
fnc — Функция обратного вызова с этой подписью: [status,opdataOut] = fnc(groupID,linkname,opdataIn).
opdataIn — Пользовательское значение или структура и передаются первому шагу итерации в opdataIn параметр fnc.
linkname — Введите имя ссылки.
Выходные аргументы
status — Значение возвращено функцией обратного вызова fnc как одно из следующего:
zero — Продолжает итерацию или возвращает нулевое значение состояния вызывающей стороне, если все члены были обработаны.
positive — Останавливает итерацию и возвращает положительное значение состояния вызывающей стороне.
negative — Останавливает итерацию и выдает ошибку при указании на отказ.
idxOut — Укажите, в котором была остановлена итерация. Это позволяет прерванной итерации быть возобновленной.
opdataOut — Значение, которое формирует opdataIn для следующего шага итерации. Итоговый opdataOut в конце итерации затем возвращен в вызывающую сторону как opdataOut.
H5L.iterate_by_name
Выполните итерации через ссылки в группе, заданной по наименованию
[status,idx_out,opdataOut] = H5L.iterate_by_name(locID,groupname,idxtype,order,idxIn,fnc,opdataIn,laplID) выполняет итерации через ссылки в группе, чтобы выполнить общую функцию, указателем на функцию которой является fnc. Начальная точка итерации соединяется заданного идентификатором местоположения и относительным названием группы. H5L.iterate_by_name рекурсивно не переходит по ссылкам в подгруппы заданной группы. Список свойств доступа к ссылке, laplID, может влиять на результат в зависимости от типа пересекаемой ссылки.
Детали
Входные параметры
locID — Группа или идентификатор файла.
groupname — Название группы.
idxtype — Тип индекса. Если ссылки не были индексированы типом индекса, они будут сначала отсортированы по тому индексу затем, итерация начнется. Если ссылки были так индексированы, шаг сортировки будет ненужным, таким образом, итерация сможет начаться более быстро. Задайте idxtype как один из этих векторов символов или строковых скаляров:
order — Индексируйте пересекающийся порядок в виде одного из этих векторов символов или строковых скаляров:
'H5_ITER_INC' — Итерация с начала до конца.
'H5_ITER_DEC' — Итерация от конца до начала.
'H5_ITER_NATIVE' — Итерация в самом быстром доступном порядке.
idxIn — Начальная точка итерации.
opdataIn — Пользовательское значение или структура и передаются первому шагу итерации в opdataIn параметр fnc.
fnc — Функция обратного вызова с этой подписью: [status,opdataOut] = fnc(groupID,linkname,opdataIn).
linkname — Введите имя ссылки.
laplID — Соедините идентификатор списка свойств доступа.
Выходные аргументы
status — Значение возвращено функцией обратного вызова fnc и интерпретированный как одно из следующего:
zero — Продолжает итерацию или возвращает нулевое значение состояния вызывающей стороне, если все члены были обработаны.
positive — Останавливает итерацию и возвращает положительное значение состояния вызывающей стороне.
negative — Останавливает итерацию и выдает ошибку при указании на отказ.
idxOut — Укажите, в котором была остановлена итерация. Это позволяет прерванной итерации быть возобновленной.
opdataOut — Значение, которое формирует opdataIn для следующего шага итерации. Итоговый opdataOut в конце итерации затем возвращен в вызывающую сторону как opdataOut.
H5L.move
Переименуйте ссылку
H5L.move(srcID,srcname,destID,destname,lcplID,laplID) переименовывает ссылку в файле HDF5. Исходная ссылка, srcname, удален из графика группы и новой ссылки, destname, вставляется. Это изменение выполняется как атомарная операция.
Детали
Входные параметры
srcID — Файл или идентификатор группы сопоставлены с существующей ссылкой.
srcname — Путь к существующей ссылке и интерпретирован относительно srcID.
destname — Имя новой ссылки.
destID — Файл или идентификатор группы, сопоставленный со ссылкой, чтобы использовать, чтобы заменить srcname в графике группы.
lcplID — Соедините идентификатор списка свойств создания.
laplID — Соедините идентификатор списка свойств доступа.
H5L.visit
Рекурсивно выполните итерации через ссылки в группе, заданной идентификатором группы
[status,opdataOut] = H5L.visit(groupID,idxtype,order,fnc,opdataIn) рекурсивно выполняет итерации через все ссылки в и ниже группы, заданной groupID, выполнять общую функцию, указателем на функцию которой является fnc.
Детали
Входные параметры
groupID — Идентификатор группы.
idxtype — Тип индекса. Если ссылки не были индексированы типом индекса, они будут сначала отсортированы по тому индексу затем, итерация начнется. Если ссылки были так индексированы, шаг сортировки будет ненужным, таким образом, итерация сможет начаться более быстро. Задайте idxtype как один из этих векторов символов или строковых скаляров:
order — Индексируйте пересекающийся порядок в виде одного из этих векторов символов или строковых скаляров:
'H5_ITER_INC' — Итерация с начала до конца.
'H5_ITER_DEC' — Итерация от конца до начала.
'H5_ITER_NATIVE' — Итерация в самом быстром доступном порядке.
opdataIn — Пользовательское значение или структура передали первому шагу итерации opdataIn параметр fnc.
fnc — Функция обратного вызова с этой подписью: [status,opdataOut] = fnc(groupID,linkname,opdataIn).
linkname — Введите имя ссылки.
Выходные аргументы
status — Значение возвращено функцией обратного вызова fnc и интерпретированный как одно из следующего:
zero — Продолжает итерацию или возвращает нулевое значение состояния вызывающей стороне, если все члены были обработаны.
positive — Останавливает итерацию и возвращает положительное значение состояния вызывающей стороне.
negative — Останавливает итерацию и выдает ошибку при указании на отказ.
opdataOut — Значение, которое формирует opdataIn для следующего шага итерации. Итоговый opdataOut в конце итерации затем возвращен в вызывающую сторону как opdataOut.
Примечание
Тип индекса передается в idxtype установка максимальных усилий. Если с передачами приложения в итерации указания значения в порядке создания и группе сталкиваются, который не был прослежен в порядке создания, что группа будет выполнена с помощью итераций в алфавитно-цифровом порядке по наименованию или порядке имени. (Назовите порядок, нативный порядок, используемый Библиотекой HDF5, и всегда доступен.)
H5L.visit_by_name
Рекурсивно выполните итерации через ссылки в группе, заданной местоположением и названием группы
[status,opdataOut] = H5L.visit_by_name(locID,groupname,idxtype,order,fnc,opdataIn,laplID) рекурсивно выполняет итерации, хотя все ссылки в и ниже группы, чтобы выполнить общую функцию, указателем на функцию которой является fnc. Начальная точка итерации задана соединением ID местоположения и относительного названия группы. Список свойств доступа к ссылке, laplID, может влиять на результат в зависимости от типа пересекаемой ссылки.
Детали
Входные параметры
locID — Группа или идентификатор файла.
groupname — Название группы.
idxtype — Тип индекса. Если ссылки не были индексированы типом индекса, они будут сначала отсортированы по тому индексу затем, итерация начнется. Если ссылки были так индексированы, шаг сортировки будет ненужным, таким образом, итерация сможет начаться более быстро. Задайте idxtype как один из этих векторов символов или строковых скаляров:
order — Индексируйте пересекающийся порядок в виде одного из этих векторов символов или строковых скаляров:
'H5_ITER_INC' — Итерация с начала до конца.
'H5_ITER_DEC' — Итерация от конца до начала.
'H5_ITER_NATIVE' — Итерация в самом быстром доступном порядке.
opdataIn — Пользовательское значение или структура передали первому шагу итерации opdataIn параметр fnc.
fnc — Функция обратного вызова с этой подписью: [status,opdataOut] = fnc(groupID,linkname,opdataIn).
linkname — Введите имя ссылки.
laplID — Соедините идентификатор списка свойств доступа.
Выходные аргументы
status — Значение возвращено функцией обратного вызова fnc и интерпретированный как одно из следующего:
zero — Продолжает итерацию или возвращает нулевое значение состояния вызывающей стороне, если все члены были обработаны.
positive — Останавливает итерацию и возвращает положительное значение состояния вызывающей стороне.
negative — Останавливает итерацию и выдает ошибку при указании на отказ.
opdataOut — Значение, которое формирует opdataIn для следующего шага итерации. Итоговый opdataOut в конце итерации затем возвращен в вызывающую сторону как opdataOut.
Примечание
Тип индекса передается в idxtype установка максимальных усилий. Если с передачами приложения в итерации указания значения в порядке создания и группе сталкиваются, который не был прослежен в порядке создания, что группа будет выполнена с помощью итераций в алфавитно-цифровом порядке по наименованию или порядке имени. (Назовите порядок, нативный порядок, используемый Библиотекой HDF5, и всегда доступен.)
