/**************************************************************************** * NCSA HDF * * Software Development Group * * National Center for Supercomputing Applications * * University of Illinois at Urbana-Champaign * * 605 E. Springfield, Champaign IL 61820 * * * * For conditions of distribution and use, see the accompanying * * hdf/COPYING file. * * * ****************************************************************************/ /* * This file contains function prototypes for each exported function in the * H5P module. */ #ifndef _H5Ppublic_H #define _H5Ppublic_H /* Default Template for creation, access, etc. templates */ #define H5P_DEFAULT 0 /* Public headers needed by this file */ #include "H5public.h" #include "H5Ipublic.h" #include "H5Dpublic.h" #include "H5Fpublic.h" #include "H5MMpublic.h" #include "H5Zpublic.h" /* Metroworks doesn't define off_t. */ #ifdef __MWERKS__ typedef long off_t; /* Metroworks does not define EINTR in */ # define EINTR 4 #endif /*__MWERKS__*/ /* Property list classes */ typedef enum H5P_class_t_old { H5P_NO_CLASS_OLD = -1, /*error return value */ H5P_FILE_ACCESS_OLD = 0, /*file access properties */ H5P_MOUNT_OLD = 1, /*file mounting properties */ H5P_NCLASSES_OLD /*this must be last! */ } H5P_class_t_old; /* This typedef should go in the v1.4 compat section when all the internal */ /* property lists are switched to generic property lists - QAK */ typedef hid_t H5P_class_t; /* Alias H5P_class_t to hid_t */ /* hid_t aliases for old H5P_class_t enum values */ /* These go away as each old-style property list is converted to a generic */ /* property list -QAK */ /* Also - merge/delete H5Pcreate and H5Pcreate_list */ /* - merge/delete H5Pget_class and H5Pget_class_new */ /* - merge/delete H5Pcopy and H5Pcopy_new */ /* - merge/delete H5Pclose and H5Pclose_list */ __DLLVAR__ hid_t H5P_NO_CLASS; __DLLVAR__ hid_t H5P_FILE_ACCESS; __DLLVAR__ hid_t H5P_MOUNT; /* H5P_DATASET_XFER was the name from the beginning through 1.2. It was * changed to H5P_DATA_XFER on v1.3.0. Then it was changed back to * H5P_DATASET_XFER right before the release of v1.4.0-beta2. * Define an alias here to help applications that had ported to v1.3. * Should be removed in later version. */ #define H5P_DATA_XFER H5P_DATASET_XFER /* Define property list class callback function pointer types */ typedef herr_t (*H5P_cls_create_func_t)(hid_t prop_id, void *create_data); typedef herr_t (*H5P_cls_copy_func_t)(hid_t new_prop_id, hid_t old_prop_id, void *copy_data); typedef herr_t (*H5P_cls_close_func_t)(hid_t prop_id, void *close_data); /* Define property list callback function pointer types */ typedef herr_t (*H5P_prp_create_func_t)(const char *name, size_t size, void *def_value); typedef herr_t (*H5P_prp_set_func_t)(hid_t prop_id, const char *name, size_t size, void *value); typedef herr_t (*H5P_prp_get_func_t)(hid_t prop_id, const char *name, size_t size, void *value); typedef herr_t (*H5P_prp_delete_func_t)(hid_t prop_id, const char *name, size_t size, void *value); typedef herr_t (*H5P_prp_copy_func_t)(const char *name, size_t size, void *value); typedef herr_t (*H5P_prp_close_func_t)(const char *name, size_t size, void *value); /* Define property list iteration function type */ typedef herr_t (*H5P_iterate_t)(hid_t id, const char *name, void *iter_data); #ifdef __cplusplus extern "C" { #endif /* * The library created property list classes */ #define H5P_NO_CLASS_NEW (H5open(), H5P_CLS_NO_CLASS_g) #define H5P_NO_CLASS_HASH_SIZE 1 /* 1, not 0, otherwise allocations get weird */ #define H5P_FILE_CREATE (H5open(), H5P_CLS_FILE_CREATE_g) #define H5P_FILE_CREATE_HASH_SIZE 17 #define H5P_FILE_ACCESS_NEW (H5open(), H5P_CLS_FILE_ACCESS_g) #define H5P_FILE_ACCESS_HASH_SIZE 17 #define H5P_DATASET_CREATE (H5open(), H5P_CLS_DATASET_CREATE_g) #define H5P_DATASET_CREATE_HASH_SIZE 17 #define H5P_DATASET_XFER (H5open(), H5P_CLS_DATASET_XFER_g) #define H5P_DATASET_XFER_HASH_SIZE 17 #define H5P_MOUNT_NEW (H5open(), H5P_CLS_MOUNT_g) #define H5P_MOUNT_HASH_SIZE 17 __DLLVAR__ hid_t H5P_CLS_NO_CLASS_g; __DLLVAR__ hid_t H5P_CLS_FILE_CREATE_g; __DLLVAR__ hid_t H5P_CLS_FILE_ACCESS_g; __DLLVAR__ hid_t H5P_CLS_DATASET_CREATE_g; __DLLVAR__ hid_t H5P_CLS_DATASET_XFER_g; __DLLVAR__ hid_t H5P_CLS_MOUNT_g; /* * The library created default property lists */ #define H5P_NO_CLASS_DEFAULT (H5open(), H5P_LST_NO_CLASS_g) #define H5P_FILE_CREATE_DEFAULT (H5open(), H5P_LST_FILE_CREATE_g) #define H5P_FILE_ACCESS_DEFAULT (H5open(), H5P_LST_FILE_ACCESS_g) #define H5P_DATASET_CREATE_DEFAULT (H5open(), H5P_LST_DATASET_CREATE_g) #define H5P_DATASET_XFER_DEFAULT (H5open(), H5P_LST_DATASET_XFER_g) #define H5P_MOUNT_DEFAULT (H5open(), H5P_LST_MOUNT_g) __DLLVAR__ hid_t H5P_LST_NO_CLASS_g; __DLLVAR__ hid_t H5P_LST_FILE_CREATE_g; __DLLVAR__ hid_t H5P_LST_FILE_ACCESS_g; __DLLVAR__ hid_t H5P_LST_DATASET_CREATE_g; __DLLVAR__ hid_t H5P_LST_DATASET_XFER_g; __DLLVAR__ hid_t H5P_LST_MOUNT_g; /* Public functions */ __DLL__ hid_t H5Pcreate_class(hid_t parent, const char *name, unsigned hashsize, H5P_cls_create_func_t cls_create, void *create_data, H5P_cls_copy_func_t cls_copy, void *copy_data, H5P_cls_close_func_t cls_close, void *close_data); __DLL__ char *H5Pget_class_name(hid_t pclass_id); __DLL__ hid_t H5Pcreate_list(hid_t cls_id); __DLL__ herr_t H5Pregister(hid_t cls_id, const char *name, size_t size, void *def_value, H5P_prp_create_func_t prp_create, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_del, H5P_prp_copy_func_t prp_copy, H5P_prp_close_func_t prp_close); __DLL__ herr_t H5Pinsert(hid_t plist_id, const char *name, size_t size, void *value, H5P_prp_set_func_t prp_set, H5P_prp_get_func_t prp_get, H5P_prp_delete_func_t prp_delete, H5P_prp_copy_func_t prp_copy, H5P_prp_close_func_t prp_close); __DLL__ herr_t H5Pset(hid_t plist_id, const char *name, void *value); __DLL__ htri_t H5Pexist(hid_t plist_id, const char *name); __DLL__ herr_t H5Pget_size(hid_t id, const char *name, size_t *size); __DLL__ herr_t H5Pget_nprops(hid_t id, size_t *nprops); __DLL__ hid_t H5Pget_class_new(hid_t plist_id); __DLL__ hid_t H5Pget_class_parent(hid_t pclass_id); __DLL__ herr_t H5Pget(hid_t plist_id, const char *name, void * value); __DLL__ htri_t H5Pequal(hid_t id1, hid_t id2); __DLL__ htri_t H5Pisa_class(hid_t plist_id, hid_t pclass_id); __DLL__ int H5Piterate(hid_t id, int *idx, H5P_iterate_t iter_func, void *iter_data); __DLL__ herr_t H5Pcopy_prop(hid_t dst_id, hid_t src_id, const char *name); __DLL__ herr_t H5Premove(hid_t plist_id, const char *name); __DLL__ herr_t H5Punregister(hid_t pclass_id, const char *name); __DLL__ herr_t H5Pclose_list(hid_t plist_id); __DLL__ herr_t H5Pclose_class(hid_t plist_id); __DLL__ hid_t H5Pcreate(hid_t type); __DLL__ herr_t H5Pclose(hid_t plist_id); __DLL__ hid_t H5Pcopy(hid_t plist_id); __DLL__ hid_t H5Pget_class(hid_t plist_id); __DLL__ herr_t H5Pget_version(hid_t plist_id, int *boot/*out*/, int *freelist/*out*/, int *stab/*out*/, int *shhdr/*out*/); __DLL__ herr_t H5Pset_userblock(hid_t plist_id, hsize_t size); __DLL__ herr_t H5Pget_userblock(hid_t plist_id, hsize_t *size); __DLL__ herr_t H5Pset_alignment(hid_t fapl_id, hsize_t threshold, hsize_t alignment); __DLL__ herr_t H5Pget_alignment(hid_t fapl_id, hsize_t *threshold/*out*/, hsize_t *alignment/*out*/); __DLL__ herr_t H5Pset_sizes(hid_t plist_id, size_t sizeof_addr, size_t sizeof_size); __DLL__ herr_t H5Pget_sizes(hid_t plist_id, size_t *sizeof_addr/*out*/, size_t *sizeof_size/*out*/); __DLL__ herr_t H5Pset_sym_k(hid_t plist_id, int ik, unsigned lk); __DLL__ herr_t H5Pget_sym_k(hid_t plist_id, int *ik/*out*/, unsigned *lk/*out*/); __DLL__ herr_t H5Pset_istore_k(hid_t plist_id, int ik); __DLL__ herr_t H5Pget_istore_k(hid_t plist_id, int *ik/*out*/); __DLL__ herr_t H5Pset_layout(hid_t plist_id, H5D_layout_t layout); __DLL__ H5D_layout_t H5Pget_layout(hid_t plist_id); __DLL__ herr_t H5Pset_chunk(hid_t plist_id, int ndims, const hsize_t dim[]); __DLL__ int H5Pget_chunk(hid_t plist_id, int max_ndims, hsize_t dim[]/*out*/); __DLL__ herr_t H5Pset_external(hid_t plist_id, const char *name, off_t offset, hsize_t size); __DLL__ int H5Pget_external_count(hid_t plist_id); __DLL__ herr_t H5Pget_external(hid_t plist_id, int idx, size_t name_size, char *name/*out*/, off_t *offset/*out*/, hsize_t *size/*out*/); __DLL__ herr_t H5Pset_driver(hid_t plist_id, hid_t driver_id, const void *driver_info); __DLL__ hid_t H5Pget_driver(hid_t plist_id); __DLL__ void *H5Pget_driver_info(hid_t plist_id); __DLL__ herr_t H5Pset_buffer(hid_t plist_id, size_t size, void *tconv, void *bkg); __DLL__ size_t H5Pget_buffer(hid_t plist_id, void **tconv/*out*/, void **bkg/*out*/); __DLL__ herr_t H5Pset_preserve(hid_t plist_id, hbool_t status); __DLL__ int H5Pget_preserve(hid_t plist_id); __DLL__ herr_t H5Pset_filter(hid_t plist_id, H5Z_filter_t filter, unsigned int flags, size_t cd_nelmts, const unsigned int c_values[]); __DLL__ int H5Pget_nfilters(hid_t plist_id); __DLL__ H5Z_filter_t H5Pget_filter(hid_t plist_id, int filter, unsigned int *flags/*out*/, size_t *cd_nelmts/*out*/, unsigned cd_values[]/*out*/, size_t namelen, char name[]); __DLL__ herr_t H5Pset_deflate(hid_t plist_id, unsigned aggression); __DLL__ herr_t H5Pset_cache(hid_t plist_id, int mdc_nelmts, size_t rdcc_nelmts, size_t rdcc_nbytes, double rdcc_w0); __DLL__ herr_t H5Pget_cache(hid_t plist_id, int *mdc_nelmts/*out*/, size_t *rdcc_nelmts/*out*/, size_t *rdcc_nbytes/*out*/, double *rdcc_w0); __DLL__ herr_t H5Pset_hyper_cache(hid_t plist_id, unsigned cache, unsigned limit); __DLL__ herr_t H5Pget_hyper_cache(hid_t plist_id, unsigned *cache, unsigned *limit); __DLL__ herr_t H5Pset_btree_ratios(hid_t plist_id, double left, double middle, double right); __DLL__ herr_t H5Pget_btree_ratios(hid_t plist_id, double *left/*out*/, double *middle/*out*/, double *right/*out*/); __DLL__ herr_t H5Pset_fill_value(hid_t plist_id, hid_t type_id, const void *value); __DLL__ herr_t H5Pget_fill_value(hid_t plist_id, hid_t type_id, void *value/*out*/); __DLL__ herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref); __DLL__ herr_t H5Pget_gc_references(hid_t fapl_id, unsigned *gc_ref/*out*/); __DLL__ herr_t H5Pset_vlen_mem_manager(hid_t plist_id, H5MM_allocate_t alloc_func, void *alloc_info, H5MM_free_t free_func, void *free_info); __DLL__ herr_t H5Pget_vlen_mem_manager(hid_t plist_id, H5MM_allocate_t *alloc_func, void **alloc_info, H5MM_free_t *free_func, void **free_info); __DLL__ herr_t H5Pset_meta_block_size(hid_t fapl_id, size_t size); __DLL__ herr_t H5Pget_meta_block_size(hid_t fapl_id, size_t *size/*out*/); __DLL__ herr_t H5Pset_sieve_buf_size(hid_t fapl_id, size_t size); __DLL__ herr_t H5Pget_sieve_buf_size(hid_t fapl_id, size_t *size/*out*/); __DLL__ herr_t H5Pset_hyper_vector_size(hid_t fapl_id, size_t size); __DLL__ herr_t H5Pget_hyper_vector_size(hid_t fapl_id, size_t *size/*out*/); #ifdef __cplusplus } #endif #endif