ddn.lib.hdf5.h5o

HDF5 Object Binding

This module provides D bindings for HDF5 object operations (H5O API).

License

BSD-3-Clause

enum H5O_INFO H5O_NATIVE_INFO H5O_type_t

struct H5_ih_info_t H5O_hdr_info_t H5O_info1_t H5O_info2_t H5O_native_info_t

fn H5Oare_mdc_flushes_disabled H5Oclose H5Ocopy H5Odecr_refcount H5Odisable_mdc_flushes H5Oenable_mdc_flushes H5Oexists_by_name H5Oflush H5Oget_comment H5Oget_comment_by_name H5Oget_info1 H5Oget_info2 H5Oget_info3 H5Oget_info_by_idx1 H5Oget_info_by_idx2 H5Oget_info_by_idx3 H5Oget_info_by_name1 H5Oget_info_by_name2 H5Oget_info_by_name3 H5Oget_native_info H5Oget_native_info_by_idx H5Oget_native_info_by_name H5Oincr_refcount H5Olink H5Oopen H5Oopen_by_addr H5Oopen_by_idx H5Oopen_by_token H5Orefresh H5Oset_comment H5Oset_comment_by_name H5Otoken_cmp H5Otoken_from_str H5Otoken_to_str H5Ovisit1 H5Ovisit2 H5Ovisit3 H5Ovisit_by_name1 H5Ovisit_by_name2 H5Ovisit_by_name3

Types 10

enumH5O_type_t : int

Object type

UNKNOWN = - 1

GROUP = 0

DATASET = 1

NAMED_DATATYPE = 2

MAP = 3

NTYPES = 4

enumH5O_INFO : uint

Object info fields flags

BASIC = 0x0001

TIME = 0x0002

NUM_ATTRS = 0x0004

ALL = 0x0007

enumH5O_NATIVE_INFO : uint

Native object info fields flags.

These flags determine which fields will be filled in the H5O_native_info_t struct.

HDR = 0x0008Fill in the hdr field

META_SIZE = 0x0010Fill in the meta_size field

ALL = 0x0018Fill in all fields

structH5_ih_info_t

Index storage information structure.

Contains size information for index and heap storage.

Fields

hsize_t index_sizeIndex size

hsize_t heap_sizeHeap size

structH5O_hdr_info_t

Object header information structure.

Contains metadata about an object's header in the file.

Fields

uint version_Version number of header format in file

uint nmesgsNumber of object header messages

uint nchunksNumber of object header chunks

uint flagsObject header status flags

Nested Templates

Space usage information

Message type flags

structH5O_native_info_t

Native file format information structure for objects.

Used by H5Oget_native_info(), H5Oget_native_info_by_name(), and H5Oget_native_info_by_idx() to return native file format information.

Fields

H5O_hdr_info_t hdrObject header information

Nested Templates

Extra metadata storage for obj & attributes

structH5O_info1_t

Object information structure (version 1, deprecated)

Fields

ulong filenoFile number

haddr_t addrObject address in file

H5O_type_t typeObject type

uint rcReference count of object

long atimeAccess time

long mtimeModification time

long ctimeChange time

long btimeBirth time

hsize_t num_attrsNumber of attributes

H5O_hdr_info_t hdrObject header information

Nested Templates

Extra metadata storage

structH5O_info2_t

Object information structure (version 2)

Fields

ulong fileno

H5O_token_t token

H5O_type_t type

uint rc

long atime

long mtime

long ctime

long btime

hsize_t num_attrs

aliasH5O_iterate1_t = herr_t function(hid_t obj, const char * name, const H5O_info1_t * info, void * op_data)

Object iteration callback (version 1, deprecated)

aliasH5O_iterate2_t = herr_t function(hid_t obj, const char * name, const H5O_info2_t * info, void * op_data)

Object iteration callback (version 2)

Functions 40

fnhid_t H5Oopen(hid_t loc_id, const char * name, hid_t lapl_id)Opens an object

fnhid_t H5Oopen_by_token(hid_t loc_id, H5O_token_t token)Opens an object by token

hid_t H5Oopen_by_idx(hid_t loc_id,  const  char *  group_name,  H5_index_t idx_type,
       H5_iter_order_t order,  hsize_t n,  hid_t lapl_id)

Opens an object by index

fnherr_t H5Oclose(hid_t object_id)Closes an object

fnhtri_t H5Oexists_by_name(hid_t loc_id, const char * name, hid_t lapl_id)Checks if object exists by name

fnherr_t H5Oget_info3(hid_t loc_id, H5O_info2_t * oinfo, uint fields)Gets object information

herr_t H5Oget_info_by_name3(hid_t loc_id,  const  char *  name,  H5O_info2_t *  oinfo,
       uint  fields,  hid_t lapl_id)

Gets object information by name

herr_t H5Oget_info_by_idx3(hid_t loc_id,  const  char *  group_name,
       H5_index_t idx_type,  H5_iter_order_t order,  hsize_t n,
       H5O_info2_t *  oinfo,  uint  fields,  hid_t lapl_id)

Gets object information by index

herr_t H5Olink(hid_t obj_id,  hid_t new_loc_id,  const  char *  new_name,
       hid_t lcpl_id,  hid_t lapl_id)

Links an object

herr_t H5Ocopy(hid_t src_loc_id,  const  char *  src_name,  hid_t dst_loc_id,
       const  char *  dst_name,  hid_t ocpypl_id,  hid_t lcpl_id)

Copies an object

fnherr_t H5Oincr_refcount(hid_t object_id)Increments object reference count

fnherr_t H5Odecr_refcount(hid_t object_id)Decrements object reference count

fnherr_t H5Oflush(hid_t obj_id)Flushes object to disk

fnherr_t H5Orefresh(hid_t oid)Refreshes object

herr_t H5Ovisit3(hid_t obj_id,  H5_index_t idx_type,  H5_iter_order_t order,
       H5O_iterate2_t op,  void *  op_data,  uint  fields)

Visits objects

herr_t H5Ovisit_by_name3(hid_t loc_id,  const  char *  obj_name,
       H5_index_t idx_type,  H5_iter_order_t order,  H5O_iterate2_t op,
       void *  op_data,  uint  fields,  hid_t lapl_id)

Visits objects by name

herr_t H5Otoken_cmp(hid_t loc_id,  const  H5O_token_t *  token1,
       const  H5O_token_t *  token2,  int *  cmp_value)

Compares two object tokens

herr_t H5Otoken_to_str(hid_t loc_id,  const  H5O_token_t *  token,
       char * *  token_str)

Converts token to string

herr_t H5Otoken_from_str(hid_t loc_id,  const  char *  token_str,
       H5O_token_t *  token)

Converts string to token

fnherr_t H5Oget_native_info(hid_t loc_id, H5O_native_info_t * oinfo, uint fields)Retrieves native file format information for an object.

herr_t H5Oget_native_info_by_name(hid_t loc_id,  const  char *  name,
       H5O_native_info_t *  oinfo,  uint  fields,  hid_t lapl_id)

Retrieves native file format information for an object by name.

herr_t H5Oget_native_info_by_idx(hid_t loc_id,  const  char *  group_name,
       H5_index_t idx_type,  H5_iter_order_t order,  hsize_t n,
       H5O_native_info_t *  oinfo,  uint  fields,  hid_t lapl_id)

Retrieves native file format information for an object by index.

fnherr_t H5Odisable_mdc_flushes(hid_t object_id)Disables metadata cache flushes for an object.

fnherr_t H5Oenable_mdc_flushes(hid_t object_id)Enables metadata cache flushes for an object.

fnherr_t H5Oare_mdc_flushes_disabled(hid_t object_id, hbool_t * are_disabled)Checks if metadata cache flushes are disabled for an object.

fnhid_t H5Oopen_by_addr(hid_t loc_id, haddr_t addr)Opens an object by address (deprecated).

fnssize_t H5Oget_comment(hid_t obj_id, char * comment, size_t bufsize)Gets the comment for an object.

ssize_t H5Oget_comment_by_name(hid_t loc_id,  const  char *  name,
       char *  comment,  size_t bufsize,  hid_t lapl_id)

Gets the comment for an object by name.

fnherr_t H5Oset_comment(hid_t obj_id, const char * comment)Sets a comment for an object.

herr_t H5Oset_comment_by_name(hid_t loc_id,  const  char *  name,
       const  char *  comment,  hid_t lapl_id)

Sets a comment for an object by name.

fnherr_t H5Oget_info1(hid_t loc_id, H5O_info1_t * oinfo)Gets object information (version 1, deprecated).

fnherr_t H5Oget_info2(hid_t loc_id, H5O_info1_t * oinfo, uint fields)Gets object information (version 2, deprecated).

herr_t H5Oget_info_by_name1(hid_t loc_id,  const  char *  name,
       H5O_info1_t *  oinfo,  hid_t lapl_id)

Gets object information by name (version 1, deprecated).

herr_t H5Oget_info_by_name2(hid_t loc_id,  const  char *  name,
       H5O_info1_t *  oinfo,  uint  fields,  hid_t lapl_id)

Gets object information by name (version 2, deprecated).

herr_t H5Oget_info_by_idx1(hid_t loc_id,  const  char *  group_name,
       H5_index_t idx_type,  H5_iter_order_t order,  hsize_t n,
       H5O_info1_t *  oinfo,  hid_t lapl_id)

Gets object information by index (version 1, deprecated).

herr_t H5Oget_info_by_idx2(hid_t loc_id,  const  char *  group_name,
       H5_index_t idx_type,  H5_iter_order_t order,  hsize_t n,
       H5O_info1_t *  oinfo,  uint  fields,  hid_t lapl_id)

Gets object information by index (version 2, deprecated).

herr_t H5Ovisit1(hid_t obj_id,  H5_index_t idx_type,  H5_iter_order_t order,
       H5O_iterate1_t op,  void *  op_data)

Visits objects (version 1, deprecated).

herr_t H5Ovisit2(hid_t obj_id,  H5_index_t idx_type,  H5_iter_order_t order,
       H5O_iterate1_t op,  void *  op_data,  uint  fields)

Visits objects (version 2, deprecated).

herr_t H5Ovisit_by_name1(hid_t loc_id,  const  char *  obj_name,
       H5_index_t idx_type,  H5_iter_order_t order,
       H5O_iterate1_t op,  void *  op_data,  hid_t lapl_id)

Visits objects by name (version 1, deprecated).

herr_t H5Ovisit_by_name2(hid_t loc_id,  const  char *  obj_name,
       H5_index_t idx_type,  H5_iter_order_t order,
       H5O_iterate1_t op,  void *  op_data,  uint  fields,  hid_t lapl_id)

Visits objects by name (version 2, deprecated).