mirror of
https://github.com/Unidata/netcdf-c.git
synced 2024-12-27 08:49:16 +08:00
102 lines
4.0 KiB
C
102 lines
4.0 KiB
C
/*********************************************************************
|
|
* Copyright 2018, University Corporation for Atmospheric
|
|
* Research/Unidata. See \ref copyright file for copying and
|
|
* redistribution conditionsmore information.
|
|
*********************************************************************/
|
|
#ifndef _NCCOMPS_H_
|
|
#define _NCCOMPS_H_
|
|
|
|
typedef struct { /* dimension */
|
|
char name[NC_MAX_NAME];
|
|
size_t size;
|
|
} ncdim_t;
|
|
|
|
/* forward declarations */
|
|
struct nctype_t;
|
|
struct ncvar_t;
|
|
struct timeinfo_t;
|
|
|
|
/*
|
|
* Member function to determine if values for this type are equal,
|
|
* used to compare with fill value.
|
|
*/
|
|
typedef bool_t (*val_equals_func)(const struct nctype_t *this,
|
|
const void *v1p, const void *v2p);
|
|
/*
|
|
* Member function to convert value of this type to a string. Returns
|
|
* number of bytes in output string sb (not including trailing null)
|
|
*/
|
|
typedef int (*typ_tostring_func)(const struct nctype_t *this,
|
|
struct safebuf_t *sb,
|
|
const void *valp);
|
|
|
|
/*
|
|
* Per-variable member function to convert value of this type to a
|
|
* string. Returns number of bytes in output string sb (not
|
|
* including trailing null). This is needed because a variable
|
|
* can override its type for output, if a variable-specific format
|
|
* is specified in an attribute.
|
|
*/
|
|
typedef int (*val_tostring_func)(const struct ncvar_t *this,
|
|
struct safebuf_t *sb,
|
|
const void *valp);
|
|
|
|
typedef struct nctype_t { /* type */
|
|
int ncid; /* group in which type is defined */
|
|
nc_type tid; /* type ID */
|
|
char *name; /* relative name of type within its group */
|
|
char *grps; /* full prefix for type name, eg "grp1/grp2" */
|
|
int class; /* > 0 for netCDF-4 user-defined types */
|
|
size_t size; /* like sizeof, even for user-defined types */
|
|
nc_type base_tid; /* for netCDF-4 enums, vlens */
|
|
size_t nfields; /* for netCDF-4 compound types */
|
|
const char *fmt; /* if non-null, format for printing values */
|
|
nc_type *fids; /* type id for each field of compound type */
|
|
size_t *offsets; /* offsets for each field of compound type */
|
|
int *ranks; /* rank for each field of compound type */
|
|
int **sides; /* rank sizes for each field where rank > 0 */
|
|
int *nvals; /* num of values for each field (prod of sides) */
|
|
/* member functions */
|
|
val_equals_func val_equals; /* function to compare 2 values for equality */
|
|
typ_tostring_func typ_tostring; /* default function to convert
|
|
* value to string for output (can
|
|
* be overridden by per-variable
|
|
* function, if fmt attribute
|
|
* is specified for a variable) */
|
|
} nctype_t;
|
|
|
|
typedef struct ncvar_t { /* variable */
|
|
char name[NC_MAX_NAME];
|
|
nc_type type;
|
|
struct nctype_t *tinfo; /* full type information */
|
|
int ndims; /* number of dimensions (rank) */
|
|
int *dims; /* dimension ids */
|
|
int natts; /* number of attributes */
|
|
bool_t has_fillval; /* has a fill value defined? */
|
|
void* fillvalp; /* pointer to the fill value, if any */
|
|
bool_t has_timeval; /* has date-time values, for -t output option */
|
|
struct timeinfo_t *timeinfo;/* if time values, units, calendar, and origin */
|
|
bool_t is_bnds_var; /* cell bounds variable, inherits timeinfo */
|
|
const char *fmt; /* overriding variable-specific format for
|
|
printing values or base values, if any */
|
|
int locid; /* group id */
|
|
/* member functions */
|
|
val_tostring_func val_tostring; /* function to convert value to string for
|
|
output */
|
|
} ncvar_t;
|
|
|
|
typedef struct ncatt_t { /* attribute */
|
|
int var;
|
|
char name[NC_MAX_NAME];
|
|
nc_type type;
|
|
nctype_t *tinfo;
|
|
size_t len;
|
|
char *string; /* for NcML text attributes (type = NC_CHAR)
|
|
* TODO: eliminate and just use valgp */
|
|
double *vals; /* for NcML numeric attributes of all types
|
|
* TODO: eliminate and just use valgp */
|
|
void *valgp; /* generic pointer to values of any type */
|
|
} ncatt_t;
|
|
|
|
#endif /*_NCCOMPS_H_ */
|