1998-02-26 03:13:49 +08:00
|
|
|
/****************************************************************************
|
|
|
|
* 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 (-2)
|
|
|
|
|
|
|
|
/* Public headers needed by this file */
|
|
|
|
#include <H5public.h>
|
1998-03-18 06:46:27 +08:00
|
|
|
#include <H5Ipublic.h>
|
1998-02-26 03:13:49 +08:00
|
|
|
#include <H5Dpublic.h>
|
1998-02-27 02:05:27 +08:00
|
|
|
#include <H5Fpublic.h>
|
2000-10-10 15:43:38 +08:00
|
|
|
#include <H5MMpublic.h>
|
1998-04-18 05:29:43 +08:00
|
|
|
#include <H5Zpublic.h>
|
1998-02-26 03:13:49 +08:00
|
|
|
|
1998-10-09 01:13:14 +08:00
|
|
|
/* Property list classes */
|
1998-02-26 03:13:49 +08:00
|
|
|
typedef enum H5P_class_t {
|
2000-07-26 01:35:17 +08:00
|
|
|
H5P_NO_CLASS = -1, /*error return value */
|
|
|
|
H5P_FILE_CREATE = 0, /*file creation properties */
|
|
|
|
H5P_FILE_ACCESS = 1, /*file access properties */
|
|
|
|
H5P_DATASET_CREATE = 2, /*dataset creation properties */
|
|
|
|
H5P_DATA_XFER = 3, /*data transfer properties */
|
|
|
|
H5P_MOUNT = 4, /*file mounting properties */
|
|
|
|
|
|
|
|
H5P_NCLASSES = 5 /*this must be last! */
|
1998-02-26 03:13:49 +08:00
|
|
|
} H5P_class_t;
|
|
|
|
|
1999-10-07 02:11:46 +08:00
|
|
|
/* Alias for the previous H5P_DATASER_XFER property list */
|
|
|
|
/* This should eventually be publicly decommisioned - 10/6/99 - QAK */
|
|
|
|
#define H5P_DATASET_XFER H5P_DATA_XFER
|
|
|
|
|
2000-07-26 01:35:17 +08:00
|
|
|
/* 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_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, void **def_value);
|
|
|
|
typedef herr_t (*H5P_prp_set_func_t)(hid_t prop_id, const char *name, void **value);
|
|
|
|
typedef herr_t (*H5P_prp_get_func_t)(hid_t prop_id, const char *name, void *value);
|
|
|
|
typedef herr_t (*H5P_prp_close_func_t)(const char *name, void *value);
|
|
|
|
|
1998-02-26 03:13:49 +08:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2000-07-26 01:35:17 +08:00
|
|
|
/*
|
|
|
|
* The library created property list classes
|
|
|
|
*/
|
|
|
|
#define H5P_NO_CLASS_NEW (H5open(), H5P_NO_CLASS_g)
|
2000-09-06 23:34:30 +08:00
|
|
|
#define H5P_NO_CLASS_HASH_SIZE 1 /* 1, not 0, otherwise allocations get weird */
|
2000-07-26 01:35:17 +08:00
|
|
|
#define H5P_FILE_CREATE_NEW (H5open(), H5P_FILE_CREATE_g)
|
|
|
|
#define H5P_FILE_CREATE_HASH_SIZE 17
|
|
|
|
#define H5P_FILE_ACCESS_NEW (H5open(), H5P_FILE_ACCESS_g)
|
|
|
|
#define H5P_FILE_ACCESS_HASH_SIZE 17
|
|
|
|
#define H5P_DATASET_CREATE_NEW (H5open(), H5P_DATASET_CREATE_g)
|
|
|
|
#define H5P_DATASET_CREATE_HASH_SIZE 17
|
|
|
|
#define H5P_DATA_XFER_NEW (H5open(), H5P_DATA_XFER_g)
|
|
|
|
#define H5P_DATA_XFER_HASH_SIZE 17
|
|
|
|
#define H5P_MOUNT_NEW (H5open(), H5P_MOUNT_g)
|
|
|
|
#define H5P_MOUNT_HASH_SIZE 17
|
|
|
|
__DLLVAR__ hid_t H5P_NO_CLASS_g;
|
|
|
|
__DLLVAR__ hid_t H5P_FILE_CREATE_g;
|
|
|
|
__DLLVAR__ hid_t H5P_FILE_ACCESS_g;
|
|
|
|
__DLLVAR__ hid_t H5P_DATASET_CREATE_g;
|
|
|
|
__DLLVAR__ hid_t H5P_DATA_XFER_g;
|
|
|
|
__DLLVAR__ hid_t H5P_MOUNT_g;
|
|
|
|
|
1998-02-26 03:13:49 +08:00
|
|
|
/* Public functions */
|
2000-07-26 01:35:17 +08:00
|
|
|
__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_close_func_t cls_close, void *close_data);
|
|
|
|
__DLL__ hid_t H5Pcreate_list(hid_t cls_id);
|
2000-09-22 23:29:47 +08:00
|
|
|
__DLL__ herr_t H5Pregister(hid_t cls_id, const char *name, size_t size,
|
2000-07-26 01:35:17 +08:00
|
|
|
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_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_close_func_t prp_close);
|
|
|
|
__DLL__ herr_t H5Pset(hid_t plist_id, const char *name, void *value);
|
2000-11-12 08:09:36 +08:00
|
|
|
__DLL__ htri_t H5Pexist(hid_t plist_id, const char *name);
|
2000-11-14 01:02:55 +08:00
|
|
|
__DLL__ herr_t H5Pget_size(hid_t plist_id, const char *name, size_t *size);
|
2000-07-26 01:35:17 +08:00
|
|
|
__DLL__ herr_t H5Pget(hid_t plist_id, const char *name, void * value);
|
|
|
|
__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);
|
1999-02-19 00:21:34 +08:00
|
|
|
__DLL__ hid_t H5Pcreate(H5P_class_t type);
|
|
|
|
__DLL__ herr_t H5Pclose(hid_t plist_id);
|
|
|
|
__DLL__ hid_t H5Pcopy(hid_t plist_id);
|
|
|
|
__DLL__ H5P_class_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, int lk);
|
|
|
|
__DLL__ herr_t H5Pget_sym_k(hid_t plist_id, int *ik/*out*/, int *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*/);
|
1999-08-11 04:21:32 +08:00
|
|
|
__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);
|
1999-02-19 00:21:34 +08:00
|
|
|
__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[]);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ int H5Pget_nfilters(hid_t plist_id);
|
|
|
|
__DLL__ H5Z_filter_t H5Pget_filter(hid_t plist_id, int filter,
|
1999-01-22 02:33:39 +08:00
|
|
|
unsigned int *flags/*out*/,
|
|
|
|
size_t *cd_nelmts/*out*/,
|
|
|
|
unsigned cd_values[]/*out*/,
|
|
|
|
size_t namelen, char name[]);
|
1999-02-19 00:21:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_deflate(hid_t plist_id, unsigned aggression);
|
|
|
|
__DLL__ herr_t H5Pset_cache(hid_t plist_id, int mdc_nelmts, int rdcc_nelmts,
|
|
|
|
size_t rdcc_nbytes, double rdcc_w0);
|
|
|
|
__DLL__ herr_t H5Pget_cache(hid_t plist_id, int *mdc_nelmts/*out*/,
|
|
|
|
int *rdcc_nelmts/*out*/,
|
|
|
|
size_t *rdcc_nbytes/*out*/, double *rdcc_w0);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_hyper_cache(hid_t plist_id, unsigned cache,
|
1999-01-22 02:33:39 +08:00
|
|
|
unsigned limit);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pget_hyper_cache(hid_t plist_id, unsigned *cache,
|
1999-01-22 02:33:39 +08:00
|
|
|
unsigned *limit);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_btree_ratios(hid_t plist_id, double left, double middle,
|
1999-01-22 02:33:39 +08:00
|
|
|
double right);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pget_btree_ratios(hid_t plist_id, double *left/*out*/,
|
1999-01-22 02:33:39 +08:00
|
|
|
double *middle/*out*/,
|
|
|
|
double *right/*out*/);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_fill_value(hid_t plist_id, hid_t type_id,
|
1999-01-22 02:33:39 +08:00
|
|
|
const void *value);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pget_fill_value(hid_t plist_id, hid_t type_id,
|
1999-01-22 02:33:39 +08:00
|
|
|
void *value/*out*/);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
|
2000-05-19 00:40:20 +08:00
|
|
|
__DLL__ herr_t H5Pget_gc_references(hid_t fapl_id, unsigned *gc_ref/*out*/);
|
1999-07-03 18:31:26 +08:00
|
|
|
__DLL__ herr_t H5Pset_vlen_mem_manager(hid_t plist_id,
|
2000-05-19 00:40:20 +08:00
|
|
|
H5MM_allocate_t alloc_func,
|
|
|
|
void *alloc_info, H5MM_free_t free_func,
|
|
|
|
void *free_info);
|
1999-07-03 18:31:26 +08:00
|
|
|
__DLL__ herr_t H5Pget_vlen_mem_manager(hid_t plist_id,
|
2000-05-19 00:40:20 +08:00
|
|
|
H5MM_allocate_t *alloc_func,
|
|
|
|
void **alloc_info,
|
|
|
|
H5MM_free_t *free_func,
|
|
|
|
void **free_info);
|
2000-09-01 03:24:36 +08:00
|
|
|
__DLL__ herr_t H5Pset_meta_block_size(hid_t fapl_id, hsize_t size);
|
|
|
|
__DLL__ herr_t H5Pget_meta_block_size(hid_t fapl_id, hsize_t *size/*out*/);
|
2000-09-27 06:50:18 +08:00
|
|
|
__DLL__ herr_t H5Pset_sieve_buf_size(hid_t fapl_id, hsize_t size);
|
|
|
|
__DLL__ herr_t H5Pget_sieve_buf_size(hid_t fapl_id, hsize_t *size/*out*/);
|
1998-11-25 08:29:09 +08:00
|
|
|
|
1998-02-26 03:13:49 +08:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
#endif
|