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>
|
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 {
|
|
|
|
H5P_NO_CLASS = -1, /*error return value */
|
1998-10-09 01:13:14 +08:00
|
|
|
H5P_FILE_CREATE = 0, /*file creation properties */
|
|
|
|
H5P_FILE_ACCESS = 1, /*file access properties */
|
|
|
|
H5P_DATASET_CREATE = 2, /*dataset creation properties */
|
|
|
|
H5P_DATASET_XFER = 3, /*dataset transfer properties */
|
|
|
|
H5P_MOUNT = 4, /*file mounting properties */
|
1998-02-26 03:13:49 +08:00
|
|
|
|
1998-10-09 01:13:14 +08:00
|
|
|
H5P_NCLASSES = 5 /*this must be last! */
|
1998-02-26 03:13:49 +08:00
|
|
|
} H5P_class_t;
|
|
|
|
|
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
|
|
|
/* Public functions */
|
1999-02-02 23:47: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*/,
|
1999-01-22 02:33:39 +08:00
|
|
|
int *freelist/*out*/, int *stab/*out*/,
|
|
|
|
int *shhdr/*out*/);
|
1999-02-02 23:47:34 +08:00
|
|
|
__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,
|
1999-01-22 02:33:39 +08:00
|
|
|
hsize_t alignment);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pget_alignment (hid_t fapl_id, hsize_t *threshold/*out*/,
|
1999-01-22 02:33:39 +08:00
|
|
|
hsize_t *alignment/*out*/);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_sizes (hid_t plist_id, size_t sizeof_addr,
|
1999-01-22 02:33:39 +08:00
|
|
|
size_t sizeof_size);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pget_sizes (hid_t plist_id, size_t *sizeof_addr/*out*/,
|
1999-01-22 02:33:39 +08:00
|
|
|
size_t *sizeof_size/*out*/);
|
1999-02-02 23:47:34 +08:00
|
|
|
__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,
|
1999-01-22 02:33:39 +08:00
|
|
|
hsize_t size);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ int H5Pget_external_count (hid_t plist_id);
|
|
|
|
__DLL__ herr_t H5Pget_external (hid_t plist_id, int idx, size_t name_size,
|
1999-01-22 02:33:39 +08:00
|
|
|
char *name/*out*/, off_t *offset/*out*/,
|
|
|
|
hsize_t *size/*out*/);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ H5F_driver_t H5Pget_driver (hid_t plist_id);
|
|
|
|
__DLL__ herr_t H5Pset_stdio (hid_t plist_id);
|
|
|
|
__DLL__ herr_t H5Pget_stdio (hid_t plist_id);
|
|
|
|
__DLL__ herr_t H5Pset_sec2 (hid_t plist_id);
|
|
|
|
__DLL__ herr_t H5Pget_sec2 (hid_t plist_id);
|
|
|
|
__DLL__ herr_t H5Pset_core (hid_t plist_id, size_t increment);
|
|
|
|
__DLL__ herr_t H5Pget_core (hid_t plist_id, size_t *increment/*out*/);
|
|
|
|
__DLL__ herr_t H5Pset_split (hid_t plist_id, const char *meta_ext,
|
1999-01-22 02:33:39 +08:00
|
|
|
hid_t meta_plist_id, const char *raw_ext,
|
|
|
|
hid_t raw_plist_id);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pget_split (hid_t plist_id, size_t meta_ext_size,
|
1999-01-22 02:33:39 +08:00
|
|
|
char *meta_ext/*out*/,
|
|
|
|
hid_t *meta_properties/*out*/,
|
|
|
|
size_t raw_ext_size, char *raw_ext/*out*/,
|
|
|
|
hid_t *raw_properties/*out*/);
|
1998-02-27 02:05:27 +08:00
|
|
|
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_family (hid_t plist_id, hsize_t memb_size,
|
1999-01-22 02:33:39 +08:00
|
|
|
hid_t memb_plist_id);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pget_family (hid_t plist_id, hsize_t *memb_size/*out*/,
|
1999-01-22 02:33:39 +08:00
|
|
|
hid_t *memb_plist_id/*out*/);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_buffer (hid_t plist_id, size_t size, void *tconv,
|
1999-01-22 02:33:39 +08:00
|
|
|
void *bkg);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ size_t H5Pget_buffer (hid_t plist_id, void **tconv/*out*/,
|
1999-01-22 02:33:39 +08:00
|
|
|
void **bkg/*out*/);
|
1999-02-02 23:47:34 +08:00
|
|
|
__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,
|
1999-01-22 02:33:39 +08:00
|
|
|
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-02 23:47: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,
|
1999-01-22 02:33:39 +08:00
|
|
|
size_t rdcc_nbytes, double rdcc_w0);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pget_cache (hid_t plist_id, int *mdc_nelmts/*out*/,
|
1999-01-22 02:33:39 +08:00
|
|
|
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*/);
|
1998-03-17 09:29:54 +08:00
|
|
|
|
1998-02-26 03:13:49 +08:00
|
|
|
#ifdef HAVE_PARALLEL
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_mpi (hid_t plist_id, MPI_Comm comm, MPI_Info info);
|
|
|
|
__DLL__ herr_t H5Pget_mpi (hid_t plist_id, MPI_Comm *comm/*out*/,
|
1999-01-22 02:33:39 +08:00
|
|
|
MPI_Info *info/*out*/);
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_xfer (hid_t plist_id, H5D_transfer_t data_xfer_mode);
|
|
|
|
__DLL__ herr_t H5Pget_xfer (hid_t plist_id,
|
1999-01-22 02:33:39 +08:00
|
|
|
H5D_transfer_t *data_xfer_mode/*out*/);
|
1998-02-26 03:13:49 +08:00
|
|
|
#endif
|
|
|
|
|
1999-02-02 23:47:34 +08:00
|
|
|
__DLL__ herr_t H5Pset_gc_references(hid_t fapl_id, unsigned gc_ref);
|
|
|
|
__DLL__ herr_t H5Pget_gc_reference(hid_t fapl_id, unsigned *gc_ref/*out*/);
|
1998-11-25 08:29:09 +08:00
|
|
|
|
1998-02-26 03:13:49 +08:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
#endif
|