/*
##############################################################################
# 
# Copyright by The HDF Group.
# All rights reserved.
#
# This file is part of the hl_region High-Level HDF5 APIs.  The full copyright 
# notice, including terms governing use, modification, and redistribution, 
# is contained in the file COPYING, which can be found at the root of the
# source code distribution tree and in the documentation directory (doc/html/). 
# If you do not have access to this file, you may request a copy of 
# "the hl_region High-Level HDF5 APIs copyright and license statement" from 
# help@hdfgroup.org.
# 
##############################################################################
*/

#ifndef _hl_region_H5LRpublic_H
#define _hl_region_H5LRpublic_H

#include "h5hl_api.h"

#ifdef __cplusplus
extern "C" {
#endif

/*-------------------------------------------------------------------------
 *
 * Make dataset functions
 *
 *-------------------------------------------------------------------------
 */

H5_HLRDLL herr_t H5LRmake_dataset(hid_t loc_id,
				 const char *path, 
				 hid_t type_id, const size_t buf_size,
				 const hid_t *loc_id_ref,
				 const hdset_reg_ref_t *buf);

/*-------------------------------------------------------------------------
 *
 * Make and manipulate dataset region references functions
 *
 *-------------------------------------------------------------------------
 */
H5_HLRDLL herr_t H5LRcreate_region_references(hid_t obj_id,
					     size_t num_elem,
					     const char **path,
					     const hsize_t *block_coord,
					     hdset_reg_ref_t *buf);

H5_HLRDLL herr_t H5LRcopy_reference(hid_t obj_id, hdset_reg_ref_t *ref, const char *file,
				    const char *path, const hsize_t *block_coord, 
				    hdset_reg_ref_t *ref_new);

H5_HLRDLL herr_t H5LRcopy_region(hid_t obj_id,
				hdset_reg_ref_t *ref,
				const char *file,
				const char *path,
				const hsize_t *block_coord);

H5_HLRDLL herr_t H5LRcreate_ref_to_all(hid_t loc_id, const char *group_path,
					 const char *ds_path, H5_index_t index_type, H5_iter_order_t order, H5R_type_t ref_type);

/*-------------------------------------------------------------------------
 *
 * Read dataset functions
 *
 *-------------------------------------------------------------------------
 */

H5_HLRDLL herr_t H5LRread_region(hid_t obj_id,
				const hdset_reg_ref_t *ref, 
				hid_t mem_type,
				size_t *numelem,
				void *buf );

/*-------------------------------------------------------------------------
 *
 * Query dataset functions
 *
 *-------------------------------------------------------------------------
 */

H5_HLRDLL herr_t H5LRget_region_info(hid_t obj_id,
				    const hdset_reg_ref_t *ref,  
				    size_t *len, 
				    char *path,
				    int *rank,
				    hid_t *dtype,
				    H5S_sel_type *sel_type,
				    size_t *numelem,
				    hsize_t *buf );

/*-------------------------------------------------------------------------
 *
 * FORTRAN specific functions
 *
 *-------------------------------------------------------------------------
 */
H5_HLRDLL herr_t H5LRmake_dataset_FORTRAN(hid_t loc_id, const char *path, hid_t type_id,
					 const size_t buf_size, const hid_t *loc_id_ref, 
					 const hdset_reg_ref_t *ref);

/*-------------------------------------------------------------------------
 *
 * Utility functions
 *
 *-------------------------------------------------------------------------
 */


#ifdef __cplusplus
}
#endif

#endif