You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
97 lines
3.6 KiB
97 lines
3.6 KiB
/*********************************************************************
|
|
* Copyright 2018, UCAR/Unidata
|
|
* See netcdf/COPYRIGHT file for copying and redistribution conditions.
|
|
* $Id$
|
|
* $Header$
|
|
*********************************************************************/
|
|
|
|
/*
|
|
* In order to use any of the netcdf_XXX.h files, it is necessary
|
|
* to include netcdf.h followed by any netcdf_XXX.h files.
|
|
* Various things (like EXTERNL) are defined in netcdf.h
|
|
* to make them available for use by the netcdf_XXX.h files.
|
|
*/
|
|
|
|
#ifndef NCAUX_H
|
|
#define NCAUX_H
|
|
|
|
#define NCAUX_ALIGN_C 0
|
|
#define NCAUX_ALIGN_UNIFORM 1
|
|
|
|
#if defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
|
|
|
|
/**
|
|
Reclaim a vector of instances of arbitrary type.
|
|
Intended for use with e.g. nc_get_vara or the input to e.g. nc_put_vara.
|
|
This recursively walks the top-level instances to
|
|
reclaim any nested data such as vlen or strings or such.
|
|
|
|
Assumes it is passed a pointer to count instances of xtype.
|
|
Reclaims any nested data.
|
|
WARNING: ncaux_reclaim_data does not reclaim the top-level memory
|
|
because we do not know how it was allocated.
|
|
However ncaux_reclaim_data_all does reclaim top-level memory.
|
|
|
|
WARNING: all data blocks below the top-level (e.g. string instances)
|
|
will be reclaimed, so do not call if there is any static data in the instance.
|
|
|
|
Should work for any netcdf format.
|
|
|
|
WARNING: deprecated in favor the corresponding function in netcdf.h.
|
|
These are just wrappers for nc_reclaim_data and
|
|
nc_reclaim_data_all and nc_copy_data and nc_copy_data_all and
|
|
are here for back compatibilty.
|
|
*/
|
|
|
|
EXTERNL int ncaux_reclaim_data(int ncid, int xtype, void* memory, size_t count);
|
|
EXTERNL int ncaux_reclaim_data_all(int ncid, int xtype, void* memory, size_t count);
|
|
|
|
/**************************************************/
|
|
/* Capture the id and parameters for a filter
|
|
using the HDF5 unsigned int format
|
|
*/
|
|
typedef struct NC_H5_Filterspec {
|
|
unsigned int filterid; /**< ID for arbitrary filter. */
|
|
size_t nparams; /**< nparams for arbitrary filter. */
|
|
unsigned int* params; /**< Params for arbitrary filter. */
|
|
} NC_H5_Filterspec;
|
|
|
|
EXTERNL int ncaux_h5filterspec_parse(const char* txt, unsigned int* idp, size_t* nparamsp, unsigned int** paramsp);
|
|
EXTERNL int ncaux_h5filterspec_parselist(const char* txt0, int* formatp, size_t* nspecsp, struct NC_H5_Filterspec*** vectorp);
|
|
EXTERNL int ncaux_h5filterspec_parse_parameter(const char* txt, size_t* nuiparamsp, unsigned int* uiparams);
|
|
EXTERNL void ncaux_h5filterspec_free(struct NC_H5_Filterspec* f);
|
|
EXTERNL void ncaux_h5filterspec_fix8(unsigned char* mem, int decode);
|
|
|
|
/**************************************************/
|
|
/* Wrappers to export selected functions from libnetcdf */
|
|
|
|
EXTERNL int ncaux_readfile(const char* filename, size_t* sizep, void** content);
|
|
EXTERNL int ncaux_writefile(const char* filename, size_t size, void* content);
|
|
|
|
/**************************************************/
|
|
|
|
/* Takes any type */
|
|
EXTERNL int ncaux_type_alignment(int xtype, int ncid, size_t* alignp);
|
|
EXTERNL int ncaux_class_alignment(int ncclass, size_t* alignp);
|
|
|
|
/**************************************************/
|
|
/* Takes type classes only */
|
|
|
|
/* Build compound types and properly handle offset and alignment */
|
|
|
|
EXTERNL int ncaux_class_alignment(int ncclass, size_t* alignp);
|
|
EXTERNL int ncaux_begin_compound(int ncid, const char *name, int alignmode, void** tag);
|
|
EXTERNL int ncaux_end_compound(void* tag, nc_type* xtypeid);
|
|
EXTERNL int ncaux_abort_compound(void* tag);
|
|
EXTERNL int ncaux_add_field(void* tag, const char *name, nc_type field_type,
|
|
int ndims, const int* dimsizes);
|
|
|
|
#if defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /*NCAUX_H*/
|
|
|
|
|