nxt4internal.h

Go to the documentation of this file.

 
#ifndef NXT4INTERNAL_H
#define NXT4INTERNAL_H
 
#include <hdf5.h>
#include "nep_nc4.h"
#include "nep.h"
#include "nextcdf4dispatch.h"
 
#define NEXTCDF4_BACKEND_ATT "_Nextcdf4Backend"
#define NEXTCDF4_MODEL_ATT "_Nextcdf4Model"
#define NEXTCDF4_BACKEND_VALUE "NEXTCDF-4/1.0"
 
#define NEXTCDF4_DIMID_ATT "_Netcdf4Dimid"
#define NEXTCDF4_VARID_ATT "_Nextcdf4Varid"
#define NEXTCDF4_VARDIMIDS_ATT "_Netcdf4Coordinates"
#define NEXTCDF4_DIMCLASS "DIMENSION_SCALE"
#define NEXTCDF4_DIMNAME_ATT "NAME"
 
typedef struct NEXTCDF4_FILE_INFO
{
    hid_t hdfid;        
    hid_t rootid;       
    char *path;         
    int mode;           
    int no_write;       
    int define_mode;    
    int netcdf4_model;  
    int backend_marked; 
} NEXTCDF4_FILE_INFO_T;
 
typedef struct NEXTCDF4_GRP_INFO
{
    hid_t hdf_group;    
} NEXTCDF4_GRP_INFO_T;
 
typedef struct NEXTCDF4_DIM_INFO
{
    hid_t hdf_dataset;  
} NEXTCDF4_DIM_INFO_T;
 
typedef struct NEXTCDF4_VAR_INFO
{
    hid_t hdf_dataset;  
    int deflate_level;  
    int shuffle;        
    int fletcher32;     
} NEXTCDF4_VAR_INFO_T;
 
typedef struct NEXTCDF4_TYPE_INFO
{
    hid_t hdf_type;     
} NEXTCDF4_TYPE_INFO_T;
 
int NEXTCDF4_add_file(int ncid, const char *path, int mode,
                      NEXTCDF4_FILE_INFO_T **filep);
int NEXTCDF4_get_file(int ncid, NC_FILE_INFO_T **h5p,
                      NEXTCDF4_FILE_INFO_T **filep);
int NEXTCDF4_free_file(NEXTCDF4_FILE_INFO_T *file);
int NEXTCDF4_write_markers(NEXTCDF4_FILE_INFO_T *file);
int NEXTCDF4_read_markers(NEXTCDF4_FILE_INFO_T *file);
int NEXTCDF4_hdf_error(void);
 
int NEXTCDF4_check_write_define(NEXTCDF4_FILE_INFO_T *file);
 
int NEXTCDF4_map_hdf_type(nc_type xtype, hid_t *typep);
 
int NEXTCDF4_type_size(nc_type xtype, size_t *sizep);
 
const char *NEXTCDF4_type_name(nc_type xtype);
 
int NEXTCDF4_check_atomic_type(NEXTCDF4_FILE_INFO_T *file, nc_type xtype);
 
int NEXTCDF4_load_metadata(NEXTCDF4_FILE_INFO_T *file, NC_FILE_INFO_T *h5);
 
int NEXTCDF4__enddef(int ncid, size_t h_minfree, size_t v_align,
                     size_t v_minfree, size_t r_align);
 
int NEXTCDF4_redef(int ncid);
 
int NEXTCDF4_def_dim(int ncid, const char *name, size_t len, int *idp);
 
int NEXTCDF4_inq_dim(int ncid, int dimid, char *name, size_t *lenp);
 
int NEXTCDF4_def_var(int ncid, const char *name, nc_type xtype, int ndims,
                     const int *dimidsp, int *varidp);
 
int NEXTCDF4_def_var_chunking(int ncid, int varid, int storage,
                              const size_t *chunksizesp);
int NEXTCDF4_def_var_deflate(int ncid, int varid, int shuffle,
                             int deflate, int deflate_level);
int NEXTCDF4_def_var_fletcher32(int ncid, int varid, int fletcher32);
int NEXTCDF4_def_var_fill(int ncid, int varid, int no_fill, const void *fill_value);
int NEXTCDF4_def_var_endian(int ncid, int varid, int endianness);
int NEXTCDF4_def_var_quantize(int ncid, int varid, int quantize_mode, int nsd);
int NEXTCDF4_def_var_filter(int ncid, int varid, unsigned int id, size_t nparams,
                            const unsigned int *params);
 
int NEXTCDF4_inq_var(int ncid, int varid, char *name, nc_type *xtypep,
                     int *ndimsp, int *dimidsp, int *nattsp);
int NEXTCDF4_inq_var_all(int ncid, int varid, char *name, nc_type *xtypep,
                         int *ndimsp, int *dimidsp, int *nattsp,
                         int *shufflep, int *deflatep, int *deflate_levelp,
                         int *fletcher32p, int *contiguousp, size_t *chunksizesp,
                         int *no_fillp, void *fill_valuep, int *endiannessp,
                         unsigned int *idp, size_t *nparamsp, unsigned int *params);
int NEXTCDF4_inq_var_filter_ids(int ncid, int varid, size_t *nfiltersp,
                                unsigned int *ids);
int NEXTCDF4_inq_var_filter_info(int ncid, int varid, unsigned int id,
                                 size_t *nparamsp, unsigned int *params);
 
int NEXTCDF4_get_vara(int, int, const size_t *, const size_t *, void *, nc_type);
int NEXTCDF4_put_vara(int, int, const size_t *, const size_t *, const void *, nc_type);
int NEXTCDF4_get_vars(int, int, const size_t *, const size_t *, const ptrdiff_t *, void *, nc_type);
int NEXTCDF4_put_vars(int, int, const size_t *, const size_t *, const ptrdiff_t *, const void *, nc_type);
int NEXTCDF4_get_varm(int, int, const size_t *, const size_t *, const ptrdiff_t *, const ptrdiff_t *, void *, nc_type);
int NEXTCDF4_put_varm(int, int, const size_t *, const size_t *, const ptrdiff_t *, const ptrdiff_t *, const void *, nc_type);
 
int NEXTCDF4_put_att(int ncid, int varid, const char *name, nc_type xtype,
                     size_t len, const void *value, nc_type memtype);
 
int NEXTCDF4_get_att(int ncid, int varid, const char *name, void *value,
                     nc_type memtype);
 
int NEXTCDF4_rename_att(int ncid, int varid, const char *name,
                        const char *newname);
 
int NEXTCDF4_rename_dim(int ncid, int dimid, const char *name);
 
int NEXTCDF4_rename_var(int ncid, int varid, const char *name);
 
int NEXTCDF4_del_att(int ncid, int varid, const char *name);
 
int NEXTCDF4_write_attributes(NEXTCDF4_FILE_INFO_T *file, NC_FILE_INFO_T *h5);
 
/* Group and type operations. */
int NEXTCDF4_def_grp(int ncid, const char *name, int *grpidp);
int NEXTCDF4_inq_ncid(int ncid, const char *name, int *grpidp);
int NEXTCDF4_inq_grps(int ncid, int *numgrps, int *grpidsp);
int NEXTCDF4_inq_grpname(int ncid, char *name);
int NEXTCDF4_inq_grpname_full(int ncid, size_t *lenp, char *name);
int NEXTCDF4_inq_grp_parent(int ncid, int *parentidp);
int NEXTCDF4_inq_grp_full_ncid(int ncid, const char *full_name, int *grpidp);
int NEXTCDF4_inq_typeids(int ncid, int *ntypes, int *typeids);
 
/* User-defined type operations. */
int NEXTCDF4_def_compound(int ncid, size_t size, const char *name, nc_type *typeidp);
int NEXTCDF4_insert_compound(int ncid, nc_type typeid, const char *name, size_t offset, nc_type xtype);
int NEXTCDF4_insert_array_compound(int ncid, nc_type typeid, const char *name,
                                   size_t offset, nc_type xtype, int ndims, const int *dim_sizesp);
int NEXTCDF4_inq_compound_field(int ncid, nc_type typeid, int fieldid, char *name,
                                size_t *offsetp, nc_type *fieldtypep, int *ndimsp, int *dim_sizesp);
int NEXTCDF4_inq_compound_fieldindex(int ncid, nc_type typeid, const char *name, int *fieldidxp);
int NEXTCDF4_def_vlen(int ncid, const char *name, nc_type base_typeid, nc_type *typeidp);
int NEXTCDF4_put_vlen_element(int ncid, int typeid, void *vlen_element,
                              size_t len, const void *data);
int NEXTCDF4_get_vlen_element(int ncid, int typeid, const void *vlen_element,
                              size_t *lenp, void *data);
int NEXTCDF4_def_enum(int ncid, nc_type base_typeid, const char *name, nc_type *typeidp);
int NEXTCDF4_insert_enum(int ncid, nc_type typeid, const char *name, const void *value);
int NEXTCDF4_inq_enum_member(int ncid, nc_type typeid, int idx, char *name, void *value);
int NEXTCDF4_inq_enum_ident(int ncid, nc_type typeid, long long value, char *identifier);
int NEXTCDF4_def_opaque(int ncid, size_t size, const char *name, nc_type *typeidp);
int NEXTCDF4_write_types(NC_FILE_INFO_T *h5);
int NEXTCDF4_inq_user_type(int ncid, nc_type typeid, char *name, size_t *size,
                           nc_type *base_typep, size_t *nfieldsp, int *classp);
int NEXTCDF4_inq_typeid(int ncid, const char *name, nc_type *typeidp);
int NEXTCDF4_inq_type_equal(int ncid1, nc_type typeid1, int ncid2, nc_type typeid2, int *equalp);
 
/* String and user-defined type I/O helpers. */
int NEXTCDF4_get_type_size(nc_type xtype, size_t *sizep);
 
#endif