H5Dpublic.h File Reference

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

Go to the source code of this file.

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 enum H5D_layout_t	H5D_layout_t
typedef enum H5D_chunk_index_t	H5D_chunk_index_t
typedef enum H5D_alloc_time_t	H5D_alloc_time_t
typedef enum H5D_space_status_t	H5D_space_status_t
typedef enum H5D_fill_time_t	H5D_fill_time_t
typedef enum H5D_fill_value_t	H5D_fill_value_t
typedef enum H5D_vds_view_t	H5D_vds_view_t
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 = 1, 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
H5_DLL 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)
H5_DLL hid_t	H5Dcreate_anon (hid_t file_id, hid_t type_id, hid_t space_id, hid_t plist_id, hid_t dapl_id)
H5_DLL hid_t	H5Dopen2 (hid_t file_id, const char *name, hid_t dapl_id)
H5_DLL herr_t	H5Dclose (hid_t dset_id)
H5_DLL hid_t	H5Dget_space (hid_t dset_id)
H5_DLL herr_t	H5Dget_space_status (hid_t dset_id, H5D_space_status_t *allocation)
H5_DLL hid_t	H5Dget_type (hid_t dset_id)
H5_DLL hid_t	H5Dget_create_plist (hid_t dset_id)
H5_DLL hid_t	H5Dget_access_plist (hid_t dset_id)
H5_DLL hsize_t	H5Dget_storage_size (hid_t dset_id)
H5_DLL herr_t	H5Dget_chunk_storage_size (hid_t dset_id, const hsize_t *offset, hsize_t *chunk_bytes)
H5_DLL herr_t	H5Dget_num_chunks (hid_t dset_id, hid_t fspace_id, hsize_t *nchunks)
H5_DLL herr_t	H5Dget_chunk_info_by_coord (hid_t dset_id, const hsize_t *coord, unsigned *filter_mask, haddr_t *addr, hsize_t *size)
H5_DLL herr_t	H5Dget_chunk_info (hid_t dset_id, hid_t fspace_id, hsize_t chk_idx, hsize_t *coord, unsigned *filter_mask, haddr_t *addr, hsize_t *size)
H5_DLL haddr_t	H5Dget_offset (hid_t dset_id)
H5_DLL herr_t	H5Dread (hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t plist_id, void *buf)
H5_DLL herr_t	H5Dwrite (hid_t dset_id, hid_t mem_type_id, hid_t mem_space_id, hid_t file_space_id, hid_t plist_id, const void *buf)
H5_DLL 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)
H5_DLL herr_t	H5Dread_chunk (hid_t dset_id, hid_t dxpl_id, const hsize_t *offset, uint32_t *filters, void *buf)
H5_DLL herr_t	H5Diterate (void *buf, hid_t type_id, hid_t space_id, H5D_operator_t op, void *operator_data)
H5_DLL herr_t	H5Dvlen_get_buf_size (hid_t dataset_id, hid_t type_id, hid_t space_id, hsize_t *size)
H5_DLL herr_t	H5Dfill (const void *fill, hid_t fill_type, void *buf, hid_t buf_type, hid_t space)
H5_DLL herr_t	H5Dset_extent (hid_t dset_id, const hsize_t size[])
H5_DLL herr_t	H5Dflush (hid_t dset_id)
H5_DLL herr_t	H5Drefresh (hid_t dset_id)
H5_DLL herr_t	H5Dscatter (H5D_scatter_func_t op, void *op_data, hid_t type_id, hid_t dst_space_id, void *dst_buf)
H5_DLL 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)
H5_DLL herr_t	H5Ddebug (hid_t dset_id)
H5_DLL herr_t	H5Dformat_convert (hid_t dset_id)
H5_DLL herr_t	H5Dget_chunk_index_type (hid_t did, H5D_chunk_index_t *idx_type)
H5_DLL hid_t	H5Dcreate1 (hid_t file_id, const char *name, hid_t type_id, hid_t space_id, hid_t dcpl_id)
H5_DLL hid_t	H5Dopen1 (hid_t file_id, const char *name)
H5_DLL herr_t	H5Dextend (hid_t dset_id, const hsize_t size[])
H5_DLL herr_t	H5Dvlen_reclaim (hid_t type_id, hid_t space_id, hid_t plist_id, void *buf)

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_alloc_time_t

typedef enum H5D_alloc_time_t H5D_alloc_time_t

H5D_append_cb_t

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

H5D_chunk_index_t

typedef enum H5D_chunk_index_t H5D_chunk_index_t

H5D_fill_time_t

typedef enum H5D_fill_time_t H5D_fill_time_t

H5D_fill_value_t

typedef enum H5D_fill_value_t H5D_fill_value_t

H5D_gather_func_t

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

H5D_layout_t

typedef enum H5D_layout_t H5D_layout_t

H5D_operator_t

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

H5D_scatter_func_t

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

H5D_space_status_t

typedef enum H5D_space_status_t H5D_space_status_t

H5D_vds_view_t

typedef enum H5D_vds_view_t H5D_vds_view_t

Enumeration Type Documentation

H5D_alloc_time_t

enum H5D_alloc_time_t

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

Enumerator
H5D_CHUNK_IDX_BTREE
H5D_CHUNK_IDX_SINGLE
H5D_CHUNK_IDX_NONE
H5D_CHUNK_IDX_FARRAY
H5D_CHUNK_IDX_EARRAY
H5D_CHUNK_IDX_BT2
H5D_CHUNK_IDX_NTYPES

H5D_fill_time_t

enum H5D_fill_time_t

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

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

Enumerator
H5D_LAYOUT_ERROR
H5D_COMPACT
H5D_CONTIGUOUS
H5D_CHUNKED
H5D_VIRTUAL
H5D_NLAYOUTS

H5D_space_status_t

enum H5D_space_status_t

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

Enumerator
H5D_VDS_ERROR
H5D_VDS_FIRST_MISSING
H5D_VDS_LAST_AVAILABLE

Function Documentation

H5Dclose()

H5_DLL herr_t H5Dclose

(

hid_t

dset_id

)

H5Dcreate1()

H5_DLL hid_t H5Dcreate1	(	hid_t	file_id,
		const char *	name,
		hid_t	type_id,
		hid_t	space_id,
		hid_t	dcpl_id
	)

H5Dcreate2()

H5_DLL 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
	)

H5Dcreate_anon()

H5_DLL hid_t H5Dcreate_anon	(	hid_t	file_id,
		hid_t	type_id,
		hid_t	space_id,
		hid_t	plist_id,
		hid_t	dapl_id
	)

H5Ddebug()

H5_DLL herr_t H5Ddebug

(

hid_t

dset_id

)

H5Dextend()

H5_DLL herr_t H5Dextend	(	hid_t	dset_id,
		const hsize_t	size[]
	)

H5Dfill()

H5_DLL herr_t H5Dfill	(	const void *	fill,
		hid_t	fill_type,
		void *	buf,
		hid_t	buf_type,
		hid_t	space
	)

H5Dflush()

H5_DLL herr_t H5Dflush

(

hid_t

dset_id

)

H5Dformat_convert()

H5_DLL herr_t H5Dformat_convert

(

hid_t

dset_id

)

H5Dgather()

H5_DLL 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
	)

H5Dget_access_plist()

H5_DLL hid_t H5Dget_access_plist

(

hid_t

dset_id

)

H5Dget_chunk_index_type()

H5_DLL herr_t H5Dget_chunk_index_type	(	hid_t	did,
		H5D_chunk_index_t *	idx_type
	)

H5Dget_chunk_info()

H5_DLL herr_t H5Dget_chunk_info	(	hid_t	dset_id,
		hid_t	fspace_id,
		hsize_t	chk_idx,
		hsize_t *	coord,
		unsigned *	filter_mask,
		haddr_t *	addr,
		hsize_t *	size
	)

H5Dget_chunk_info_by_coord()

H5_DLL herr_t H5Dget_chunk_info_by_coord	(	hid_t	dset_id,
		const hsize_t *	coord,
		unsigned *	filter_mask,
		haddr_t *	addr,
		hsize_t *	size
	)

H5Dget_chunk_storage_size()

H5_DLL herr_t H5Dget_chunk_storage_size	(	hid_t	dset_id,
		const hsize_t *	offset,
		hsize_t *	chunk_bytes
	)

H5Dget_create_plist()

H5_DLL hid_t H5Dget_create_plist

(

hid_t

dset_id

)

H5Dget_num_chunks()

H5_DLL herr_t H5Dget_num_chunks	(	hid_t	dset_id,
		hid_t	fspace_id,
		hsize_t *	nchunks
	)

H5Dget_offset()

H5_DLL haddr_t H5Dget_offset

(

hid_t

dset_id

)

H5Dget_space()

H5_DLL hid_t H5Dget_space

(

hid_t

dset_id

)

H5Dget_space_status()

H5_DLL herr_t H5Dget_space_status	(	hid_t	dset_id,
		H5D_space_status_t *	allocation
	)

H5Dget_storage_size()

H5_DLL hsize_t H5Dget_storage_size

(

hid_t

dset_id

)

H5Dget_type()

H5_DLL hid_t H5Dget_type

(

hid_t

dset_id

)

H5Diterate()

H5_DLL herr_t H5Diterate	(	void *	buf,
		hid_t	type_id,
		hid_t	space_id,
		H5D_operator_t	op,
		void *	operator_data
	)

H5Dopen1()

H5_DLL hid_t H5Dopen1	(	hid_t	file_id,
		const char *	name
	)

H5Dopen2()

H5_DLL hid_t H5Dopen2	(	hid_t	file_id,
		const char *	name,
		hid_t	dapl_id
	)

H5Dread()

H5_DLL herr_t H5Dread	(	hid_t	dset_id,
		hid_t	mem_type_id,
		hid_t	mem_space_id,
		hid_t	file_space_id,
		hid_t	plist_id,
		void *	buf
	)

H5Dread_chunk()

H5_DLL herr_t H5Dread_chunk	(	hid_t	dset_id,
		hid_t	dxpl_id,
		const hsize_t *	offset,
		uint32_t *	filters,
		void *	buf
	)

H5Drefresh()

H5_DLL herr_t H5Drefresh

(

hid_t

dset_id

)

H5Dscatter()

H5_DLL herr_t H5Dscatter	(	H5D_scatter_func_t	op,
		void *	op_data,
		hid_t	type_id,
		hid_t	dst_space_id,
		void *	dst_buf
	)

H5Dset_extent()

H5_DLL herr_t H5Dset_extent	(	hid_t	dset_id,
		const hsize_t	size[]
	)

H5Dvlen_get_buf_size()

H5_DLL herr_t H5Dvlen_get_buf_size	(	hid_t	dataset_id,
		hid_t	type_id,
		hid_t	space_id,
		hsize_t *	size
	)

H5Dvlen_reclaim()

H5_DLL herr_t H5Dvlen_reclaim	(	hid_t	type_id,
		hid_t	space_id,
		hid_t	plist_id,
		void *	buf
	)

H5Dwrite()

H5_DLL herr_t H5Dwrite	(	hid_t	dset_id,
		hid_t	mem_type_id,
		hid_t	mem_space_id,
		hid_t	file_space_id,
		hid_t	plist_id,
		const void *	buf
	)

H5Dwrite_chunk()

H5_DLL 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
	)