netcdf_aux.h File Reference

Go to the source code of this file.

Macros
#define	NCAUX_ALIGN_C   0
#define	NCAUX_ALIGN_UNIFORM   1

Functions
EXTERNL int	ncaux_reclaim_data (int ncid, int xtype, void *memory, size_t count)
EXTERNL int	ncaux_begin_compound (int ncid, const char *name, int alignmode, void **tag)
EXTERNL int	ncaux_end_compound (void *tag, nc_type *typeid)
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)
EXTERNL size_t	ncaux_type_alignment (int xtype, int ncid)
EXTERNL size_t	ncaux_class_alignment (int ncclass)

Macro Definition Documentation

NCAUX_ALIGN_C

#define NCAUX_ALIGN_C   0

Definition at line 18 of file netcdf_aux.h.

NCAUX_ALIGN_UNIFORM

#define NCAUX_ALIGN_UNIFORM   1

Definition at line 19 of file netcdf_aux.h.

Function Documentation

ncaux_abort_compound()

EXTERNL int ncaux_abort_compound

(

void *

tag

)

ncaux_add_field()

EXTERNL int ncaux_add_field	(	void *	tag,
		const char *	name,
		nc_type	field_type,
		int	ndims,
		const int *	dimsizes
	)

ncaux_begin_compound()

EXTERNL int ncaux_begin_compound	(	int	ncid,
		const char *	name,
		int	alignmode,
		void **	tag
	)

ncaux_class_alignment()

EXTERNL size_t ncaux_class_alignment

(

int

ncclass

)

ncaux_end_compound()

EXTERNL int ncaux_end_compound	(	void *	tag,
		nc_type *	typeid
	)

ncaux_reclaim_data()

EXTERNL int ncaux_reclaim_data	(	int	ncid,
		int	xtype,
		void *	memory,
		size_t	count
	)

Reclaim the output tree of data from a call to 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: does not reclaim the top-level memory because we do not know how it was allocated. Should work for any netcdf format.

ncaux_type_alignment()

EXTERNL size_t ncaux_type_alignment	(	int	xtype,
		int	ncid
	)