mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-21 08:39:46 +08:00
121 lines
4.0 KiB
C
121 lines
4.0 KiB
C
/* Copyright 2005-2018 University Corporation for Atmospheric
|
|
Research/Unidata. */
|
|
/**
|
|
* @file This header file contains macros, types, and prototypes for
|
|
* the HDF5 code in libhdf5. This header should not be included in
|
|
* code outside libhdf5.
|
|
*
|
|
* @author Ed Hartnett
|
|
*/
|
|
|
|
#ifndef _HDF5INTERNAL_
|
|
#define _HDF5INTERNAL_
|
|
|
|
#include "config.h"
|
|
#include <hdf5.h>
|
|
#include <hdf5_hl.h>
|
|
#include "nc4internal.h"
|
|
#include "ncdimscale.h"
|
|
#include "nc4dispatch.h"
|
|
|
|
#define NC_MAX_HDF5_NAME (NC_MAX_NAME + 10)
|
|
|
|
/* These have to do with creating chuncked datasets in HDF5. */
|
|
#define NC_HDF5_UNLIMITED_DIMSIZE (0)
|
|
#define NC_HDF5_CHUNKSIZE_FACTOR (10)
|
|
#define NC_HDF5_MIN_CHUNK_SIZE (2)
|
|
|
|
#define NC_EMPTY_SCALE "NC_EMPTY_SCALE"
|
|
|
|
/* This is an attribute I had to add to handle multidimensional
|
|
* coordinate variables. */
|
|
#define COORDINATES "_Netcdf4Coordinates"
|
|
#define COORDINATES_LEN (NC_MAX_NAME * 5)
|
|
|
|
/* This is used when the user defines a non-coordinate variable with
|
|
* same name as a dimension. */
|
|
#define NON_COORD_PREPEND "_nc4_non_coord_"
|
|
|
|
/* An attribute in the HDF5 root group of this name means that the
|
|
* file must follow strict netCDF classic format rules. */
|
|
#define NC3_STRICT_ATT_NAME "_nc3_strict"
|
|
|
|
/* If this attribute is present on a dimscale variable, use the value
|
|
* as the netCDF dimid. */
|
|
#define NC_DIMID_ATT_NAME "_Netcdf4Dimid"
|
|
|
|
/** This is the name of the class HDF5 dimension scale attribute. */
|
|
#define HDF5_DIMSCALE_CLASS_ATT_NAME "CLASS"
|
|
|
|
/** This is the name of the name HDF5 dimension scale attribute. */
|
|
#define HDF5_DIMSCALE_NAME_ATT_NAME "NAME"
|
|
|
|
/** Strut to hold HDF5-specific info for the file. */
|
|
typedef struct NC_HDF5_FILE_INFO
|
|
{
|
|
hid_t hdfid;
|
|
} NC_HDF5_FILE_INFO_T;
|
|
|
|
/* This is a struct to handle the dim metadata. */
|
|
typedef struct NC_HDF5_DIM_INFO
|
|
{
|
|
hid_t hdf_dimscaleid; /* Non-zero if a DIM_WITHOUT_VARIABLE dataset is in use (no coord var). */
|
|
HDF5_OBJID_T hdf5_objid;
|
|
} NC_HDF5_DIM_INFO_T;
|
|
|
|
/** Strut to hold HDF5-specific info for attributes. */
|
|
typedef struct NC_HDF5_ATT_INFO
|
|
{
|
|
hid_t native_hdf_typeid; /* Native HDF5 datatype for attribute's data */
|
|
} NC_HDF5_ATT_INFO_T;
|
|
|
|
/* Struct to hold HDF5-specific info for a group. */
|
|
typedef struct NC_HDF5_GRP_INFO
|
|
{
|
|
hid_t hdf_grpid;
|
|
} NC_HDF5_GRP_INFO_T;
|
|
|
|
/* Struct to hold HDF5-specific info for a variable. */
|
|
typedef struct NC_HDF5_VAR_INFO
|
|
{
|
|
hid_t hdf_datasetid;
|
|
} NC_HDF5_VAR_INFO_T;
|
|
|
|
/* Struct to hold HDF5-specific info for a field. */
|
|
typedef struct NC_HDF5_FIELD_INFO
|
|
{
|
|
hid_t hdf_typeid;
|
|
hid_t native_hdf_typeid;
|
|
} NC_HDF5_FIELD_INFO_T;
|
|
|
|
/* These functions do HDF5 things. */
|
|
int rec_detach_scales(NC_GRP_INFO_T *grp, int dimid, hid_t dimscaleid);
|
|
int rec_reattach_scales(NC_GRP_INFO_T *grp, int dimid, hid_t dimscaleid);
|
|
int delete_existing_dimscale_dataset(NC_GRP_INFO_T *grp, int dimid, NC_DIM_INFO_T *dim);
|
|
void reportopenobjects(int log, hid_t);
|
|
int nc4_rec_grp_HDF5_del(NC_GRP_INFO_T *grp);
|
|
int nc4_open_var_grp2(NC_GRP_INFO_T *grp, int varid, hid_t *dataset);
|
|
int nc4_rec_match_dimscales(NC_GRP_INFO_T *grp);
|
|
int nc4_rec_write_metadata(NC_GRP_INFO_T *grp, nc_bool_t bad_coord_order);
|
|
int nc4_rec_write_groups_types(NC_GRP_INFO_T *grp);
|
|
int nc4_enddef_netcdf4_file(NC_FILE_INFO_T *h5);
|
|
int nc4_adjust_var_cache(NC_GRP_INFO_T *grp, NC_VAR_INFO_T * var);
|
|
NC_TYPE_INFO_T *nc4_rec_find_hdf_type(NC_FILE_INFO_T* h5,
|
|
hid_t target_hdf_typeid);
|
|
int nc4_close_hdf5_file(NC_FILE_INFO_T *h5, int abort, NC_memio *memio);
|
|
|
|
/* Break & reform coordinate variables */
|
|
int nc4_break_coord_var(NC_GRP_INFO_T *grp, NC_VAR_INFO_T *coord_var, NC_DIM_INFO_T *dim);
|
|
int nc4_reform_coord_var(NC_GRP_INFO_T *grp, NC_VAR_INFO_T *coord_var, NC_DIM_INFO_T *dim);
|
|
|
|
/* In-memory functions */
|
|
extern hid_t NC4_image_init(NC_FILE_INFO_T* h5);
|
|
extern void NC4_image_finalize(void*);
|
|
|
|
/* These functions are internal to the libhdf5 directory. */
|
|
int nc4_detect_preserve_dimids(NC_GRP_INFO_T *grp, nc_bool_t *bad_coord_orderp);
|
|
int hdf5_set_log_level();
|
|
int nc4_get_fill_value(NC_FILE_INFO_T *h5, NC_VAR_INFO_T *var, void **fillp);
|
|
|
|
#endif /* _HDF5INTERNAL_ */
|