#include "H5public.h"
#include "H5Ipublic.h"

Macros
#define	H5D_CHUNK_CACHE_NSLOTS_DEFAULT ((size_t)-1)

#define	H5D_CHUNK_CACHE_NBYTES_DEFAULT ((size_t)-1)

#define	H5D_CHUNK_CACHE_W0_DEFAULT (-1.0f)

#define	H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS (0x0002u)

#define	H5D_CHUNK_BTREE H5D_CHUNK_IDX_BTREE

#define	H5D_XFER_DIRECT_CHUNK_WRITE_FLAG_NAME "direct_chunk_flag"

#define	H5D_XFER_DIRECT_CHUNK_WRITE_FILTERS_NAME "direct_chunk_filters"

#define	H5D_XFER_DIRECT_CHUNK_WRITE_OFFSET_NAME "direct_chunk_offset"

#define	H5D_XFER_DIRECT_CHUNK_WRITE_DATASIZE_NAME "direct_chunk_datasize"

#define	H5D_XFER_DIRECT_CHUNK_READ_FLAG_NAME "direct_chunk_read_flag"

#define	H5D_XFER_DIRECT_CHUNK_READ_OFFSET_NAME "direct_chunk_read_offset"

#define	H5D_XFER_DIRECT_CHUNK_READ_FILTERS_NAME "direct_chunk_read_filters"

Typedefs
typedef herr_t(*	H5D_append_cb_t) (hid_t dataset_id, hsize_t cur_dims, void op_data)

typedef herr_t(*	H5D_operator_t) (void elem, hid_t type_id, unsigned ndim, const hsize_t point, void *operator_data)

typedef herr_t(*	H5D_scatter_func_t) (const void *src_buf, size_t src_buf_bytes_used, void *op_data)

typedef herr_t(*	H5D_gather_func_t) (const void dst_buf, size_t dst_buf_bytes_used, void op_data)

Enumerations
enum	H5D_layout_t { H5D_LAYOUT_ERROR = -1, H5D_COMPACT = 0, H5D_CONTIGUOUS = 1, H5D_CHUNKED = 2, H5D_VIRTUAL = 3, H5D_NLAYOUTS = 4 }

enum	H5D_chunk_index_t { H5D_CHUNK_IDX_BTREE = 0, H5D_CHUNK_IDX_SINGLE, H5D_CHUNK_IDX_NONE = 2, H5D_CHUNK_IDX_FARRAY = 3, H5D_CHUNK_IDX_EARRAY = 4, H5D_CHUNK_IDX_BT2 = 5, H5D_CHUNK_IDX_NTYPES }

enum	H5D_alloc_time_t { H5D_ALLOC_TIME_ERROR = -1, H5D_ALLOC_TIME_DEFAULT = 0, H5D_ALLOC_TIME_EARLY = 1, H5D_ALLOC_TIME_LATE = 2, H5D_ALLOC_TIME_INCR = 3 }

enum	H5D_space_status_t { H5D_SPACE_STATUS_ERROR = -1, H5D_SPACE_STATUS_NOT_ALLOCATED = 0, H5D_SPACE_STATUS_PART_ALLOCATED = 1, H5D_SPACE_STATUS_ALLOCATED = 2 }

enum	H5D_fill_time_t { H5D_FILL_TIME_ERROR = -1, H5D_FILL_TIME_ALLOC = 0, H5D_FILL_TIME_NEVER = 1, H5D_FILL_TIME_IFSET = 2 }

enum	H5D_fill_value_t { H5D_FILL_VALUE_ERROR = -1, H5D_FILL_VALUE_UNDEFINED = 0, H5D_FILL_VALUE_DEFAULT = 1, H5D_FILL_VALUE_USER_DEFINED = 2 }

enum	H5D_vds_view_t { H5D_VDS_ERROR = -1, H5D_VDS_FIRST_MISSING = 0, H5D_VDS_LAST_AVAILABLE = 1 }

Functions
hid_t	H5Dcreate2 (hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t lcpl_id, hid_t dcpl_id, hid_t dapl_id)
	Creates a new dataset and links it into the file. More...

hid_t	H5Dcreate_anon (hid_t loc_id, hid_t type_id, hid_t space_id, hid_t dcpl_id, hid_t dapl_id)
	Creates a dataset in a file without linking it into the file structure. More...

hid_t	H5Dopen2 (hid_t loc_id, const char *name, hid_t dapl_id)
	Creates a new dataset and links it into the file. More...

hid_t	H5Dget_space (hid_t dset_id)
	Returns an identifier for a copy of the dataspace for a dataset. More...

herr_t	H5Dget_space_status (hid_t dset_id, H5D_space_status_t *allocation)

hid_t	H5Dget_type (hid_t dset_id)
	Returns an identifier for a copy of the datatype for a dataset. More...

hid_t	H5Dget_create_plist (hid_t dset_id)
	Returns an identifier for a copy of the dataset creation property list for a dataset. More...

hid_t	H5Dget_access_plist (hid_t dset_id)
	Returns the dataset access property list associated with a dataset. More...

hsize_t	H5Dget_storage_size (hid_t dset_id)
	Returns the amount of storage allocated for a dataset. More...

herr_t	H5Dget_chunk_storage_size (hid_t dset_id, const hsize_t offset, hsize_t chunk_bytes)
	Returns the amount of storage allocated within the file for a raw data chunk in a dataset. More...

herr_t	H5Dget_num_chunks (hid_t dset_id, hid_t fspace_id, hsize_t *nchunks)
	Retrieves number of chunks that have nonempty intersection with a specified selection. More...

herr_t	H5Dget_chunk_info_by_coord (hid_t dset_id, const hsize_t offset, unsigned filter_mask, haddr_t addr, hsize_t size)
	Retrieves information about a chunk specified by its coordinates. More...

herr_t	H5Dget_chunk_info (hid_t dset_id, hid_t fspace_id, hsize_t chk_idx, hsize_t offset, unsigned filter_mask, haddr_t addr, hsize_t size)
	Retrieves information about a chunk specified by its index. More...

haddr_t	H5Dget_offset (hid_t dset_id)
	Returns dataset address in file. More...

herr_t	H5Dread (hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id, void *buf)
	Reads raw data from a dataset into a provided buffer. More...

herr_t	H5Dwrite (hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t dxpl_id, const void *buf)
	Writes raw data from a buffer to a dataset. More...

herr_t	H5Dwrite_chunk (hid_t dset_id, hid_t dxpl_id, uint32_t filters, const hsize_t offset, size_t data_size, const void buf)
	Writes a raw data chunk from a buffer directly to a dataset in a file. More...

herr_t	H5Dread_chunk (hid_t dset_id, hid_t dxpl_id, const hsize_t offset, uint32_t filters, void *buf)
	Reads a raw data chunk directly from a dataset in a file into a buffer. More...

herr_t	H5Diterate (void buf, hid_t type_id, hid_t space_id, H5D_operator_t op, void operator_data)
	Iterates over all selected elements in a dataspace. More...

herr_t	H5Dvlen_get_buf_size (hid_t dset_id, hid_t type_id, hid_t space_id, hsize_t *size)
	Determines the number of bytes required to store variable-length (VL) data. More...

herr_t	H5Dfill (const void fill, hid_t fill_type_id, void buf, hid_t buf_type_id, hid_t space_id)
	Fills dataspace elements with a fill value in a memory buffer. More...

herr_t	H5Dset_extent (hid_t dset_id, const hsize_t size[])
	Changes the sizes of a dataset’s dimensions. More...

herr_t	H5Dflush (hid_t dset_id)
	Flushes all buffers associated with a dataset to disk. More...

herr_t	H5Drefresh (hid_t dset_id)
	Refreshes all buffers associated with a dataset. More...

herr_t	H5Dscatter (H5D_scatter_func_t op, void op_data, hid_t type_id, hid_t dst_space_id, void dst_buf)
	Scatters data into a selection within a memory buffer. More...

herr_t	H5Dgather (hid_t src_space_id, const void src_buf, hid_t type_id, size_t dst_buf_size, void dst_buf, H5D_gather_func_t op, void *op_data)
	Gathers data from a selection within a memory buffer raw data chunk in a dataset. More...

herr_t	H5Dclose (hid_t dset_id)
	Closes the specified dataset. More...

herr_t	H5Ddebug (hid_t dset_id)

herr_t	H5Dformat_convert (hid_t dset_id)

herr_t	H5Dget_chunk_index_type (hid_t did, H5D_chunk_index_t *idx_type)

hid_t	H5Dcreate1 (hid_t loc_id, const char *name, hid_t type_id, hid_t space_id, hid_t dcpl_id)
	Creates a dataset at the specified location. More...

hid_t	H5Dopen1 (hid_t loc_id, const char *name)
	Opens an existing dataset. More...

herr_t	H5Dextend (hid_t dset_id, const hsize_t size[])
	Extends a dataset. More...

herr_t	H5Dvlen_reclaim (hid_t type_id, hid_t space_id, hid_t dxpl_id, void *buf)
	Reclaims variable-length (VL) datatype memory buffers. More...

Macro Definition Documentation

◆ H5D_CHUNK_BTREE

#define H5D_CHUNK_BTREE H5D_CHUNK_IDX_BTREE

◆ H5D_CHUNK_CACHE_NBYTES_DEFAULT

#define H5D_CHUNK_CACHE_NBYTES_DEFAULT ((size_t)-1)

◆ H5D_CHUNK_CACHE_NSLOTS_DEFAULT

#define H5D_CHUNK_CACHE_NSLOTS_DEFAULT ((size_t)-1)

◆ H5D_CHUNK_CACHE_W0_DEFAULT

#define H5D_CHUNK_CACHE_W0_DEFAULT (-1.0f)

◆ H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS

#define H5D_CHUNK_DONT_FILTER_PARTIAL_CHUNKS (0x0002u)

◆ H5D_XFER_DIRECT_CHUNK_READ_FILTERS_NAME

#define H5D_XFER_DIRECT_CHUNK_READ_FILTERS_NAME "direct_chunk_read_filters"

◆ H5D_XFER_DIRECT_CHUNK_READ_FLAG_NAME

#define H5D_XFER_DIRECT_CHUNK_READ_FLAG_NAME "direct_chunk_read_flag"

◆ H5D_XFER_DIRECT_CHUNK_READ_OFFSET_NAME

#define H5D_XFER_DIRECT_CHUNK_READ_OFFSET_NAME "direct_chunk_read_offset"

◆ H5D_XFER_DIRECT_CHUNK_WRITE_DATASIZE_NAME

#define H5D_XFER_DIRECT_CHUNK_WRITE_DATASIZE_NAME "direct_chunk_datasize"

◆ H5D_XFER_DIRECT_CHUNK_WRITE_FILTERS_NAME

#define H5D_XFER_DIRECT_CHUNK_WRITE_FILTERS_NAME "direct_chunk_filters"

◆ H5D_XFER_DIRECT_CHUNK_WRITE_FLAG_NAME

#define H5D_XFER_DIRECT_CHUNK_WRITE_FLAG_NAME "direct_chunk_flag"

◆ H5D_XFER_DIRECT_CHUNK_WRITE_OFFSET_NAME

#define H5D_XFER_DIRECT_CHUNK_WRITE_OFFSET_NAME "direct_chunk_offset"

Typedef Documentation

◆ H5D_append_cb_t

typedef herr_t(* H5D_append_cb_t) (hid_t dataset_id, hsize_t *cur_dims, void *op_data)

Callback for H5Pset_append_flush() in a dataset access property list

◆ H5D_gather_func_t

typedef herr_t(* H5D_gather_func_t) (const void *dst_buf, size_t dst_buf_bytes_used, void *op_data)

Define the operator function pointer for H5Dgather()

◆ H5D_operator_t

typedef herr_t(* H5D_operator_t) (void *elem, hid_t type_id, unsigned ndim, const hsize_t *point, void *operator_data)

Define the operator function pointer for H5Diterate()

◆ H5D_scatter_func_t

typedef herr_t(* H5D_scatter_func_t) (const void **src_buf, size_t *src_buf_bytes_used, void *op_data)

Define the operator function pointer for H5Dscatter()

Enumeration Type Documentation

◆ H5D_alloc_time_t

enum H5D_alloc_time_t

Values for the space allocation time property

Enumerator
H5D_ALLOC_TIME_ERROR
H5D_ALLOC_TIME_DEFAULT
H5D_ALLOC_TIME_EARLY
H5D_ALLOC_TIME_LATE
H5D_ALLOC_TIME_INCR

◆ H5D_chunk_index_t

enum H5D_chunk_index_t

Types of chunk index data structures

Enumerator
H5D_CHUNK_IDX_BTREE	v1 B-tree index (default)
H5D_CHUNK_IDX_SINGLE	Single Chunk index (cur dims[]=max dims[]=chunk dims[]; filtered & non-filtered)
H5D_CHUNK_IDX_NONE	Implicit: No Index (H5D_ALLOC_TIME_EARLY, non-filtered, fixed dims)
H5D_CHUNK_IDX_FARRAY	Fixed array (for 0 unlimited dims)
H5D_CHUNK_IDX_EARRAY	Extensible array (for 1 unlimited dim)
H5D_CHUNK_IDX_BT2	v2 B-tree index (for >1 unlimited dims)
H5D_CHUNK_IDX_NTYPES	This one must be last!

◆ H5D_fill_time_t

enum H5D_fill_time_t

Values for time of writing fill value property

Enumerator
H5D_FILL_TIME_ERROR
H5D_FILL_TIME_ALLOC
H5D_FILL_TIME_NEVER
H5D_FILL_TIME_IFSET

◆ H5D_fill_value_t

enum H5D_fill_value_t

Values for fill value status

Enumerator
H5D_FILL_VALUE_ERROR
H5D_FILL_VALUE_UNDEFINED
H5D_FILL_VALUE_DEFAULT
H5D_FILL_VALUE_USER_DEFINED

◆ H5D_layout_t

enum H5D_layout_t

Values for the H5D_LAYOUT property

Enumerator
H5D_LAYOUT_ERROR
H5D_COMPACT	raw data is very small
H5D_CONTIGUOUS	the default
H5D_CHUNKED	slow and fancy
H5D_VIRTUAL	actual data is stored in other datasets
H5D_NLAYOUTS	this one must be last!

◆ H5D_space_status_t

enum H5D_space_status_t

Values for the status of space allocation

Enumerator
H5D_SPACE_STATUS_ERROR
H5D_SPACE_STATUS_NOT_ALLOCATED
H5D_SPACE_STATUS_PART_ALLOCATED
H5D_SPACE_STATUS_ALLOCATED

◆ H5D_vds_view_t

enum H5D_vds_view_t

Values for VDS bounds option

Enumerator
H5D_VDS_ERROR
H5D_VDS_FIRST_MISSING
H5D_VDS_LAST_AVAILABLE

Function Documentation

◆ H5Ddebug()

herr_t H5Ddebug ( hid_t dset_id )

◆ H5Dformat_convert()

herr_t H5Dformat_convert ( hid_t dset_id )

◆ H5Dget_chunk_index_type()

herr_t H5Dget_chunk_index_type	(	hid_t	did,
		H5D_chunk_index_t *	idx_type
	)

Macros

Typedefs

Enumerations

Functions