1/*! \file
2Functions for inquiring about variables.
3
4Copyright 2010 University Corporation for Atmospheric
5Research/Unidata. See COPYRIGHT file for more info.
6*/
7
8#include "ncdispatch.h"
9
10/** \name Learning about Variables
11
12Functions to learn about the variables in a file. */
13/*! \{ */ /* All these functions are part of this named group... */
14
15/**
16\ingroup variables
17Find the ID of a variable, from the name.
18
19The function nc_inq_varid returns the ID of a netCDF variable, given
20its name.
21
22\param ncid NetCDF or group ID, from a previous call to nc_open(),
23nc_create(), nc_def_grp(), or associated inquiry functions such as
24nc_inq_ncid().
25
26\param name Name of the variable.
27
28\param varidp Pointer to location for returned variable ID.  \ref
29ignored_if_null.
30
31\returns ::NC_NOERR No error.
32\returns ::NC_EBADID Bad ncid.
33
34\section nc_inq_varid_example4 Example
35
36Here is an example using nc_inq_varid to find out the ID of a variable
37named rh in an existing netCDF dataset named foo.nc:
38
39\code
40     #include <netcdf.h>
41        ...
42     int  status, ncid, rh_id;
43        ...
44     status = nc_open("foo.nc", NC_NOWRITE, &ncid);
45     if (status != NC_NOERR) handle_error(status);
46        ...
47     status = nc_inq_varid (ncid, "rh", &rh_id);
48     if (status != NC_NOERR) handle_error(status);
49\endcode
50 */
51int
52nc_inq_varid(int ncid, const char *name, int *varidp)
53{
54   NCncp;
55   int stat = NC_check_id(ncid, &ncp);
56   if(stat != NC_NOERR) return stat;
57   return ncp->dispatch->inq_varid(ncidnamevaridp);
58}
59
60/**
61\ingroup variables
62Learn about a variable.
63
64\param ncid NetCDF or group ID, from a previous call to nc_open(),
65nc_create(), nc_def_grp(), or associated inquiry functions such as
66nc_inq_ncid().
67
68\param varid Variable ID
69
70\param name Returned \ref object_name of variable. \ref
71ignored_if_null.
72
73\param xtypep Pointer where typeid will be stored. \ref ignored_if_null.
74
75\param ndimsp Pointer where number of dimensions will be
76stored. \ref ignored_if_null.
77
78\param dimidsp Pointer where array of dimension IDs will be
79stored. \ref ignored_if_null.
80
81\param nattsp Pointer where number of attributes will be
82stored. \ref ignored_if_null.
83
84\returns ::NC_NOERR No error.
85\returns ::NC_EBADID Bad ncid.
86\returns ::NC_ENOTVAR Invalid variable ID.
87
88\section nc_inq_var_example5 Example
89
90Here is an example using nc_inq_var() to find out about a variable named
91rh in an existing netCDF dataset named foo.nc:
92
93\code
94     #include <netcdf.h>
95        ...
96     int  status
97     int  ncid;
98     int  rh_id;
99     nc_type rh_type;
100     int rh_ndims;
101     int  rh_dimids[NC_MAX_VAR_DIMS];
102     int rh_natts
103        ...
104     status = nc_open ("foo.nc", NC_NOWRITE, &ncid);
105     if (status != NC_NOERR) handle_error(status);
106        ...
107     status = nc_inq_varid (ncid, "rh", &rh_id);
108     if (status != NC_NOERR) handle_error(status);
109     status = nc_inq_var (ncid, rh_id, 0, &rh_type, &rh_ndims, rh_dimids,
110                          &rh_natts);
111     if (status != NC_NOERR) handle_error(status);
112\endcode
113
114 */
115int
116nc_inq_var(int ncid, int varid, char *namenc_type *xtypep,
117    int *ndimsp, int *dimidsp, int *nattsp)
118{
119   NCncp;
120   int stat = NC_check_id(ncid, &ncp);
121   if(stat != NC_NOERR) return stat;
122   TRACE(nc_inq_var);
123   return ncp->dispatch->inq_var_all(ncidvaridnamextypepndimsp,
124      dimidspnattspNULLNULLNULL,
125      NULLNULLNULLNULLNULLNULLNULLNULL);
126}
127
128/**
129\ingroup variables
130Learn the name of a variable.
131
132\param ncid NetCDF or group ID, from a previous call to nc_open(),
133nc_create(), nc_def_grp(), or associated inquiry functions such as
134nc_inq_ncid().
135
136\param varid Variable ID
137
138\param name Returned variable name. The caller must allocate space for
139the returned name. The maximum length is ::NC_MAX_NAME. Ignored if
140NULL.
141
142\returns ::NC_NOERR No error.
143\returns ::NC_EBADID Bad ncid.
144\returns ::NC_ENOTVAR Invalid variable ID.
145 */
146int
147nc_inq_varname(int ncid, int varid, char *name)
148{
149   return nc_inq_var(ncidvaridnameNULLNULL,
150      NULLNULL);
151}
152
153/** Learn the type of a variable.
154\ingroup variables
155
156\param ncid NetCDF or group ID, from a previous call to nc_open(),
157nc_create(), nc_def_grp(), or associated inquiry functions such as
158nc_inq_ncid().
159
160\param varid Variable ID
161
162\param typep Pointer where typeid will be stored. \ref ignored_if_null.
163
164\returns ::NC_NOERR No error.
165\returns ::NC_EBADID Bad ncid.
166\returns ::NC_ENOTVAR Invalid variable ID.
167 */
168int
169nc_inq_vartype(int ncid, int varidnc_type *typep)
170{
171   return nc_inq_var(ncidvaridNULLtypepNULL,
172      NULLNULL);
173}
174
175/** Learn how many dimensions are associated with a variable.
176\ingroup variables
177
178\param ncid NetCDF or group ID, from a previous call to nc_open(),
179nc_create(), nc_def_grp(), or associated inquiry functions such as
180nc_inq_ncid().
181
182\param varid Variable ID
183
184\param ndimsp Pointer where number of dimensions will be
185stored. \ref ignored_if_null.
186
187\returns ::NC_NOERR No error.
188\returns ::NC_EBADID Bad ncid.
189\returns ::NC_ENOTVAR Invalid variable ID.
190 */
191int
192nc_inq_varndims(int ncid, int varid, int *ndimsp)
193{
194   return nc_inq_var(ncidvaridNULLNULLndimspNULLNULL);
195}
196
197/** Learn the dimension IDs associated with a variable.
198\ingroup variables
199
200\param ncid NetCDF or group ID, from a previous call to nc_open(),
201nc_create(), nc_def_grp(), or associated inquiry functions such as
202nc_inq_ncid().
203
204\param varid Variable ID
205
206\param dimidsp Pointer where array of dimension IDs will be
207stored. \ref ignored_if_null.
208
209\returns ::NC_NOERR No error.
210\returns ::NC_EBADID Bad ncid.
211\returns ::NC_ENOTVAR Invalid variable ID.
212 */
213int
214nc_inq_vardimid(int ncid, int varid, int *dimidsp)
215{
216   return nc_inq_var(ncidvaridNULLNULLNULL,
217      dimidspNULL);
218}
219
220/** Learn how many attributes are associated with a variable.
221\ingroup variables
222
223\param ncid NetCDF or group ID, from a previous call to nc_open(),
224nc_create(), nc_def_grp(), or associated inquiry functions such as
225nc_inq_ncid().
226
227\param varid Variable ID
228
229\param nattsp Pointer where number of attributes will be
230stored. \ref ignored_if_null.
231
232\returns ::NC_NOERR No error.
233\returns ::NC_EBADID Bad ncid.
234\returns ::NC_ENOTVAR Invalid variable ID.
235 */
236int
237nc_inq_varnatts(int ncid, int varid, int *nattsp)
238{
239   if (varid == NC_GLOBAL)
240      return nc_inq_natts(ncid,nattsp);
241   /*else*/
242   return nc_inq_var(ncidvaridNULLNULLNULLNULL,
243      nattsp);
244}
245
246#ifdef USE_NETCDF4
247/** \ingroup variables
248Learn the storage and deflate settings for a variable.
249
250This is a wrapper for nc_inq_var_all().
251
252\param ncid NetCDF or group ID, from a previous call to nc_open(),
253nc_create(), nc_def_grp(), or associated inquiry functions such as
254nc_inq_ncid().
255
256\param varid Variable ID
257
258\param shufflep A 1 will be written here if the shuffle filter is
259turned on for this variable, and a 0 otherwise. \ref ignored_if_null.
260
261\param deflatep If this pointer is non-NULL, the nc_inq_var_deflate
262function will write a 1 if the deflate filter is turned on for this
263variable, and a 0 otherwise. \ref ignored_if_null.
264
265\param deflate_levelp If the deflate filter is in use for this
266variable, the deflate_level will be writen here. \ref ignored_if_null.
267
268\returns ::NC_NOERR No error.
269\returns ::NC_ENOTNC4 Not a netCDF-4 file.
270\returns ::NC_EBADID Bad ncid.
271\returns ::NC_ENOTVAR Invalid variable ID.
272*/
273int
274nc_inq_var_deflate(int ncid, int varid, int *shufflep, int *deflatep,
275    int *deflate_levelp)
276{
277   NCncp;
278   int stat = NC_check_id(ncid,&ncp);
279   if(stat != NC_NOERR) return stat;
280   TRACE(nc_inq_var_deflate);
281   return ncp->dispatch->inq_var_all(
282      ncidvarid,
283      NULL, /*name*/
284      NULL, /*xtypep*/
285      NULL, /*ndimsp*/
286      NULL, /*dimidsp*/
287      NULL, /*nattsp*/
288      shufflep, /*shufflep*/
289      deflatep, /*deflatep*/
290      deflate_levelp, /*deflatelevelp*/
291      NULL, /*fletcher32p*/
292      NULL, /*contiguousp*/
293      NULL, /*chunksizep*/
294      NULL, /*nofillp*/
295      NULL, /*fillvaluep*/
296      NULL, /*endianp*/
297      NULL, /*optionsmaskp*/
298      NULL /*pixelsp*/
299      );
300}
301
302/** \ingroup variables
303Learn the szip settings of a variable.
304
305This function returns the szip settings for a variable. NetCDF does
306not allow variables to be created with szip (due to license problems
307with the szip library), but we do enable read-only access of HDF5
308files with szip compression.
309
310This is a wrapper for nc_inq_var_all().
311
312\param ncid NetCDF or group ID, from a previous call to nc_open(),
313nc_create(), nc_def_grp(), or associated inquiry functions such as
314nc_inq_ncid().
315
316\param varid Variable ID
317
318\param options_maskp The szip options mask will be copied to this
319pointer. \ref ignored_if_null.
320
321\param pixels_per_blockp The szip pixels per block will be copied
322here. \ref ignored_if_null.
323
324\returns ::NC_NOERR No error.
325\returns ::NC_EBADID Bad ncid.
326\returns ::NC_ENOTNC4 Not a netCDF-4 file.
327\returns ::NC_ENOTVAR Invalid variable ID.
328*/
329int
330nc_inq_var_szip(int ncid, int varid, int *options_maskp, int *pixels_per_blockp)
331{
332   NCncp;
333   int stat = NC_check_id(ncid,&ncp);
334   if(stat != NC_NOERR) return stat;
335   TRACE(nc_inq_var_szip);
336   return ncp->dispatch->inq_var_all(
337      ncidvarid,
338      NULL, /*name*/
339      NULL, /*xtypep*/
340      NULL, /*ndimsp*/
341      NULL, /*dimidsp*/
342      NULL, /*nattsp*/
343      NULL, /*shufflep*/
344      NULL, /*deflatep*/
345      NULL, /*deflatelevelp*/
346      NULL, /*fletcher32p*/
347      NULL, /*contiguousp*/
348      NULL, /*chunksizep*/
349      NULL, /*nofillp*/
350      NULL, /*fillvaluep*/
351      NULL, /*endianp*/
352      options_maskp, /*optionsmaskp*/
353      pixels_per_blockp /*pixelsp*/
354      );
355}
356
357/** \ingroup variables
358Learn the checksum settings for a variable.
359
360This is a wrapper for nc_inq_var_all().
361
362\param ncid NetCDF or group ID, from a previous call to nc_open(),
363nc_create(), nc_def_grp(), or associated inquiry functions such as
364nc_inq_ncid().
365
366\param varid Variable ID
367
368\param fletcher32p Will be set to ::NC_FLETCHER32 if the fletcher32
369checksum filter is turned on for this variable, and ::NC_NOCHECKSUM if
370it is not. \ref ignored_if_null.
371
372\returns ::NC_NOERR No error.
373\returns ::NC_EBADID Bad ncid.
374\returns ::NC_ENOTNC4 Not a netCDF-4 file.
375\returns ::NC_ENOTVAR Invalid variable ID.
376*/
377int
378nc_inq_var_fletcher32(int ncid, int varid, int *fletcher32p)
379{
380   NCncp;
381   int stat = NC_check_id(ncid,&ncp);
382   if(stat != NC_NOERR) return stat;
383   TRACE(nc_inq_var_fletcher32);
384   return ncp->dispatch->inq_var_all(
385      ncidvarid,
386      NULL, /*name*/
387      NULL, /*xtypep*/
388      NULL, /*ndimsp*/
389      NULL, /*dimidsp*/
390      NULL, /*nattsp*/
391      NULL, /*shufflep*/
392      NULL, /*deflatep*/
393      NULL, /*deflatelevelp*/
394      fletcher32p, /*fletcher32p*/
395      NULL, /*contiguousp*/
396      NULL, /*chunksizep*/
397      NULL, /*nofillp*/
398      NULL, /*fillvaluep*/
399      NULL, /*endianp*/
400      NULL, /*optionsmaskp*/
401      NULL /*pixelsp*/
402      );
403}
404
405/** \ingroup variables
406
407This is a wrapper for nc_inq_var_all().
408
409\param ncid NetCDF or group ID, from a previous call to nc_open(),
410nc_create(), nc_def_grp(), or associated inquiry functions such as
411nc_inq_ncid().
412
413\param varid Variable ID
414
415\param storagep Address of returned storage property, returned as
416::NC_CONTIGUOUS if this variable uses contiguous storage, or
417::NC_CHUNKED if it uses chunked storage. \ref ignored_if_null.
418
419\param chunksizesp The chunksizes will be copied here. \ref
420ignored_if_null.
421
422\returns ::NC_NOERR No error.
423\returns ::NC_EBADID Bad ncid.
424\returns ::NC_ENOTNC4 Not a netCDF-4 file.
425\returns ::NC_ENOTVAR Invalid variable ID.
426
427
428\section nc_inq_var_chunking_example Example
429
430\code
431        printf("**** testing contiguous storage...");
432        {
433     #define NDIMS6 1
434     #define DIM6_NAME "D5"
435     #define VAR_NAME6 "V5"
436     #define DIM6_LEN 100
437
438           int dimids[NDIMS6], dimids_in[NDIMS6];
439           int varid;
440           int ndims, nvars, natts, unlimdimid;
441           nc_type xtype_in;
442           char name_in[NC_MAX_NAME + 1];
443           int data[DIM6_LEN], data_in[DIM6_LEN];
444           size_t chunksize_in[NDIMS6];
445           int storage_in;
446           int i, d;
447
448           for (i = 0; i < DIM6_LEN; i++)
449              data[i] = i;
450
451
452           if (nc_create(FILE_NAME, NC_NETCDF4, &ncid)) ERR;
453           if (nc_def_dim(ncid, DIM6_NAME, DIM6_LEN, &dimids[0])) ERR;
454           if (dimids[0] != 0) ERR;
455           if (nc_def_var(ncid, VAR_NAME6, NC_INT, NDIMS6, dimids, &varid)) ERR;
456           if (nc_def_var_chunking(ncid, varid, NC_CONTIGUOUS, NULL)) ERR;
457           if (nc_put_var_int(ncid, varid, data)) ERR;
458
459
460           if (nc_inq_var_chunking(ncid, 0, &storage_in, chunksize_in)) ERR;
461           if (storage_in != NC_CONTIGUOUS) ERR;
462\endcode
463
464*/
465int
466nc_inq_var_chunking(int ncid, int varid, int *storagep, size_t *chunksizesp)
467{
468   NC *ncp;
469   int stat = NC_check_id(ncid, &ncp);
470   if(stat != NC_NOERR) return stat;
471   TRACE(nc_inq_var_chunking);
472   return ncp->dispatch->inq_var_all(ncidvaridNULLNULLNULLNULL,
473      NULLNULLNULLNULLNULLstoragep,
474      chunksizespNULLNULLNULLNULLNULL);
475}
476
477/** \ingroup variables
478Learn the fill mode of a variable.
479
480The fill mode of a variable is set by nc_def_var_fill().
481
482This is a wrapper for nc_inq_var_all().
483
484\param ncid NetCDF or group ID, from a previous call to nc_open(),
485nc_create(), nc_def_grp(), or associated inquiry functions such as
486nc_inq_ncid().
487
488\param varid Variable ID
489
490\param no_fill Pointer to an integer which will get a 1 if no_fill
491mode is set for this variable. \ref ignored_if_null.
492
493\param fill_valuep A pointer which will get the fill value for this
494variable. \ref ignored_if_null.
495
496\returns ::NC_NOERR No error.
497\returns ::NC_EBADID Bad ncid.
498\returns ::NC_ENOTVAR Invalid variable ID.
499*/
500int
501nc_inq_var_fill(int ncid, int varid, int *no_fill, void *fill_valuep)
502{
503   NCncp;
504   int stat = NC_check_id(ncid,&ncp);
505   if(stat != NC_NOERR) return stat;
506   TRACE(nc_inq_var_fill);
507   return ncp->dispatch->inq_var_all(
508      ncidvarid,
509      NULL, /*name*/
510      NULL, /*xtypep*/
511      NULL, /*ndimsp*/
512      NULL, /*dimidsp*/
513      NULL, /*nattsp*/
514      NULL, /*shufflep*/
515      NULL, /*deflatep*/
516      NULL, /*deflatelevelp*/
517      NULL, /*fletcher32p*/
518      NULL, /*contiguousp*/
519      NULL, /*chunksizep*/
520      no_fill, /*nofillp*/
521      fill_valuep, /*fillvaluep*/
522      NULL, /*endianp*/
523      NULL, /*optionsmaskp*/
524      NULL /*pixelsp*/
525      );
526}
527
528/** \ingroup variables
529Find the endianness of a variable.
530
531This is a wrapper for nc_inq_var_all().
532
533\param ncid NetCDF or group ID, from a previous call to nc_open(),
534nc_create(), nc_def_grp(), or associated inquiry functions such as
535nc_inq_ncid().
536
537\param varid Variable ID
538
539\param endianp Storage which will get ::NC_ENDIAN_LITTLE if this
540variable is stored in little-endian format, ::NC_ENDIAN_BIG if it is
541stored in big-endian format, and ::NC_ENDIAN_NATIVE if the endianness
542is not set, and the variable is not created yet.
543
544\returns ::NC_NOERR No error.
545\returns ::NC_ENOTNC4 Not a netCDF-4 file.
546\returns ::NC_EBADID Bad ncid.
547\returns ::NC_ENOTVAR Invalid variable ID.
548*/
549int
550nc_inq_var_endian(int ncid, int varid, int *endianp)
551{
552   NCncp;
553   int stat = NC_check_id(ncid,&ncp);
554   if(stat != NC_NOERR) return stat;
555   TRACE(nc_inq_var_endian);
556   return ncp->dispatch->inq_var_all(
557      ncidvarid,
558      NULL, /*name*/
559      NULL, /*xtypep*/
560      NULL, /*ndimsp*/
561      NULL, /*dimidsp*/
562      NULL, /*nattsp*/
563      NULL, /*shufflep*/
564      NULL, /*deflatep*/
565      NULL, /*deflatelevelp*/
566      NULL, /*fletcher32p*/
567      NULL, /*contiguousp*/
568      NULL, /*chunksizep*/
569      NULL, /*nofillp*/
570      NULL, /*fillvaluep*/
571      endianp, /*endianp*/
572      NULL, /*optionsmaskp*/
573      NULL /*pixelsp*/
574      );
575}
576
577/*! Return number and list of unlimited dimensions.
578
579In netCDF-4 files, it's possible to have multiple unlimited
580dimensions. This function returns a list of the unlimited dimension
581ids visible in a group.
582
583Dimensions are visible in a group if they have been defined in that
584group, or any ancestor group.
585
586\param ncid NetCDF group ID, from a previous call to nc_open, nc_create, nc_def_grp, etc.
587\param nunlimdimsp A pointer to an int which will get the number of visible unlimited dimensions. Ignored if NULL.
588\param unlimdimidsp A pointer to an already allocated array of int which will get the ids of all visible unlimited dimensions. Ignored if NULL. To allocate the correct length for this array, call nc_inq_unlimdims with a NULL for this parameter and use the nunlimdimsp parameter to get the number of visible unlimited dimensions.
589
590This function will return one of the following values.
591
592\returns ::NC_NOERR No error.
593\returns ::NC_EBADID Bad group id.
594\returns ::NC_ENOTNC4 Attempting a netCDF-4 operation on a netCDF-3 file. NetCDF-4 operations can only be performed on files defined with a create mode which includes flag HDF5. (see nc_open).
595\returns ::NC_ESTRICTNC3 This file was created with the strict netcdf-3 flag, therefore netcdf-4 operations are not allowed. (see nc_open).
596\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
597
598 */
599int
600nc_inq_unlimdims(int ncid, int *nunlimdimsp, int *unlimdimidsp)
601{
602    NCncp;
603    int stat = NC_check_id(ncid,&ncp);
604    if(stat != NC_NOERR) return stat;
605   TRACE(nc_inq_unlimdims);
606    return ncp->dispatch->inq_unlimdims(ncidnunlimdimsp,
607 unlimdimidsp);
608}
609
610#endif /* USE_NETCDF4 */
611
612/*!
613
614Used in libdap2 and libdap4.
615
616@param[in] ncid               ncid for file.
617@param[in] varid              varid for variable in question.
618@param[out] name              Pointer to memory to contain the name of the variable.
619@param[out] xtypep            Pointer to memory to contain the type of the variable.
620@param[out] ndimsp            Pointer to memory to store the number of associated dimensions for the variable.
621@param[out] dimidsp           Pointer to memory to store the dimids associated with the variable.
622@param[out] nattsp            Pointer to memory to store the number of attributes associated with the variable.
623@param[out] shufflep          Pointer to memory to store shuffle information associated with the variable.
624@param[out] deflatep          Pointer to memory to store compression type associated with the variable.
625@param[out] deflate_levelp    Pointer to memory to store compression level associated with the variable.
626@param[out] fletcher32p       Pointer to memory to store compression information associated with the variable.
627@param[out] contiguousp       Pointer to memory to store contiguous-data information associated with the variable.
628@param[out] chunksizesp       Pointer to memory to store chunksize information associated with the variable.
629@param[out] no_fill           Pointer to memory to store whether or not there is a fill value associated with the variable.
630@param[out] fill_valuep       Pointer to memory to store the fill value (if one exists) for the variable.
631@param[out] endiannessp       Pointer to memory to store endianness value. One of ::NC_ENDIAN_BIG ::NC_ENDIAN_LITTLE ::NC_ENDIAN_NATIVE
632@param[out] options_maskp     Pointer to memory to store mask options information.
633@param[out] pixels_per_blockp Pointer to memory to store pixels-per-block information for chunked data.
634
635\note Expose access to nc_inq_var_all().
636
637\internal
638\ingroup variables
639
640
641*/
642int
643NC_inq_var_all(int ncid, int varid, char *namenc_type *xtypep,
644               int *ndimsp, int *dimidsp, int *nattsp,
645               int *shufflep, int *deflatep, int *deflate_levelp,
646               int *fletcher32p, int *contiguousp, size_t *chunksizesp,
647               int *no_fill, void *fill_valuep, int *endiannessp,
648        int *options_maskp, int *pixels_per_blockp)
649{
650   NCncp;
651   int stat = NC_check_id(ncid,&ncp);
652   if(stat != NC_NOERR) return stat;
653   return ncp->dispatch->inq_var_all(
654      ncidvaridnamextypep,
655      ndimspdimidspnattsp,
656      shufflepdeflatepdeflate_levelpfletcher32p,
657      contiguouspchunksizesp,
658      no_fillfill_valuep,
659      endiannessp,
660      options_maskp,
661      pixels_per_blockp);
662}
663
664/*! \} */  /* End of named group ...*/


HyperKWIC - Version 7.20DA executed at 11:37 on 27 Oct 2017 | Polyhedron Solutions - INTERNAL USE | COMMERCIAL (Any O/S) SN 4AKIed