NetCDF 4.10.1
Loading...
Searching...
No Matches
netcdf.h
Go to the documentation of this file.
1
12
13#ifndef _NETCDF_
14#define _NETCDF_
15
16#include <stddef.h> /* size_t, ptrdiff_t */
17#include <errno.h> /* netcdf functions sometimes return system errors */
18
19/* Required for alloca on Windows */
20#if defined(_WIN32) || defined(_WIN64)
21#include <malloc.h>
22#endif
23
25typedef int nc_type;
26
27#if defined(__cplusplus)
28extern "C" {
29#endif
30
31/*
32 * The netcdf external data types
33 */
34#define NC_NAT 0
35#define NC_BYTE 1
36#define NC_CHAR 2
37#define NC_SHORT 3
38#define NC_INT 4
39#define NC_LONG NC_INT
40#define NC_FLOAT 5
41#define NC_DOUBLE 6
42#define NC_UBYTE 7
43#define NC_USHORT 8
44#define NC_UINT 9
45#define NC_INT64 10
46#define NC_UINT64 11
47#define NC_STRING 12
48
49#define NC_MAX_ATOMIC_TYPE NC_STRING
50
51/* The following are use internally in support of user-defines
52 * types. They are also the class returned by nc_inq_user_type. */
53#define NC_VLEN 13
54#define NC_OPAQUE 14
55#define NC_ENUM 15
56#define NC_COMPOUND 16
57
60#define NC_FIRSTUSERTYPEID 32
61
67#define NC_FILL_BYTE ((signed char)-127)
68#define NC_FILL_CHAR ((char)0)
69#define NC_FILL_SHORT ((short)-32767)
70#define NC_FILL_INT (-2147483647)
71#define NC_FILL_FLOAT (9.9692099683868690e+36f) /* near 15 * 2^119 */
72#define NC_FILL_DOUBLE (9.9692099683868690e+36)
73#define NC_FILL_UBYTE (255)
74#define NC_FILL_USHORT (65535)
75#define NC_FILL_UINT (4294967295U)
76#define NC_FILL_INT64 ((long long)-9223372036854775806LL)
77#define NC_FILL_UINT64 ((unsigned long long)18446744073709551614ULL)
78#define NC_FILL_STRING ((char *)"")
80
89#define NC_MAX_BYTE 127
90#define NC_MIN_BYTE (-NC_MAX_BYTE-1)
91#define NC_MAX_CHAR 255
92#define NC_MAX_SHORT 32767
93#define NC_MIN_SHORT (-NC_MAX_SHORT - 1)
94#define NC_MAX_INT 2147483647
95#define NC_MIN_INT (-NC_MAX_INT - 1)
96#define NC_MAX_FLOAT 3.402823466e+38f
97#define NC_MIN_FLOAT (-NC_MAX_FLOAT)
98#define NC_MAX_DOUBLE 1.7976931348623157e+308
99#define NC_MIN_DOUBLE (-NC_MAX_DOUBLE)
100#define NC_MAX_UBYTE NC_MAX_CHAR
101#define NC_MAX_USHORT 65535U
102#define NC_MAX_UINT 4294967295U
103#define NC_MAX_INT64 (9223372036854775807LL)
104#define NC_MIN_INT64 (-9223372036854775807LL-1)
105#define NC_MAX_UINT64 (18446744073709551615ULL)
107
118#ifdef NETCDF_ENABLE_LEGACY_MACROS
119#define _FillValue "_FillValue"
120#endif
121#define NC_FillValue "_FillValue"
122#define NC_FILL 0
123#define NC_NOFILL 0x100
124
125/* Define the ioflags bits for nc_create and nc_open.
126 Currently unused in lower 16 bits:
127 0x0002
128 All upper 16 bits are unused except
129 0x20000
130 0x40000
131*/
132
133/* Lower 16 bits */
134
135#define NC_NOWRITE 0x0000
136#define NC_WRITE 0x0001
137
138#define NC_CLOBBER 0x0000
139#define NC_NOCLOBBER 0x0004
140#define NC_DISKLESS 0x0008
141#define NC_MMAP 0x0010
142
143#define NC_64BIT_DATA 0x0020
144#define NC_CDF5 NC_64BIT_DATA
145
152#define NC_UDF0 0x0040
153#define NC_UDF1 0x0080
154/* UDF2-UDF9 use bits 16, 19-25 (skipping bits 17-18 which are used by
155 * NC_NOATTCREORD=0x20000 and NC_NODIMSCALE_ATTACH=0x40000) */
156#define NC_UDF2 0x10000
157#define NC_UDF3 0x80000
158#define NC_UDF4 0x100000
159#define NC_UDF5 0x200000
160#define NC_UDF6 0x400000
161#define NC_UDF7 0x800000
162#define NC_UDF8 0x1000000
163#define NC_UDF9 0x2000000
165
166#define NC_CLASSIC_MODEL 0x0100
167#define NC_64BIT_OFFSET 0x0200
168
173#define NC_LOCK 0x0400
174
177#define NC_SHARE 0x0800
178
179#define NC_NETCDF4 0x1000
180
184#define NC_MPIIO 0x2000
185#define NC_MPIPOSIX NC_MPIIO
186#define NC_PNETCDF (NC_MPIIO)
187
188#define NC_PERSIST 0x4000
189#define NC_INMEMORY 0x8000
190
191/* Upper 16 bits */
192#define NC_NOATTCREORD 0x20000
193#define NC_NODIMSCALE_ATTACH 0x40000
194
195#define NC_MAX_MAGIC_NUMBER_LEN 8
199#define NC_MAX_UDF_FORMATS 10
200
208#define NC_FORMAT_CLASSIC (1)
209/* After adding CDF5 support, the NC_FORMAT_64BIT
210 flag is somewhat confusing. So, it is renamed.
211 Note that the name in the contributed code
212 NC_FORMAT_64BIT was renamed to NC_FORMAT_CDF2
213*/
214#define NC_FORMAT_64BIT_OFFSET (2)
215#define NC_FORMAT_64BIT (NC_FORMAT_64BIT_OFFSET)
216#define NC_FORMAT_NETCDF4 (3)
217#define NC_FORMAT_NETCDF4_CLASSIC (4)
218#define NC_FORMAT_64BIT_DATA (5)
219
220/* Alias */
221#define NC_FORMAT_CDF5 NC_FORMAT_64BIT_DATA
222
223/* Define a mask covering format flags only */
224#define NC_FORMAT_ALL (NC_64BIT_OFFSET|NC_64BIT_DATA|NC_CLASSIC_MODEL|NC_NETCDF4|NC_UDF0|NC_UDF1|NC_UDF2|NC_UDF3|NC_UDF4|NC_UDF5|NC_UDF6|NC_UDF7|NC_UDF8|NC_UDF9)
225
227
245
246#define NC_FORMATX_NC3 (1)
247#define NC_FORMATX_NC_HDF5 (2)
248#define NC_FORMATX_NC4 NC_FORMATX_NC_HDF5
249#define NC_FORMATX_NC_HDF4 (3)
250#define NC_FORMATX_PNETCDF (4)
251#define NC_FORMATX_DAP2 (5)
252#define NC_FORMATX_DAP4 (6)
259#define NC_FORMATX_UDF0 (8)
260#define NC_FORMATX_UDF1 (9)
262#define NC_FORMATX_NCZARR (10)
265#define NC_FORMATX_UDF2 (11)
266#define NC_FORMATX_UDF3 (12)
267#define NC_FORMATX_UDF4 (13)
268#define NC_FORMATX_UDF5 (14)
269#define NC_FORMATX_UDF6 (15)
270#define NC_FORMATX_UDF7 (16)
271#define NC_FORMATX_UDF8 (17)
272#define NC_FORMATX_UDF9 (18)
274#define NC_FORMATX_UNDEFINED (0)
275
276 /* To avoid breaking compatibility (such as in the python library),
277 we need to retain the NC_FORMAT_xxx format as well. This may come
278 out eventually, as the NC_FORMATX is more clear that it's an extended
279 format specifier.*/
280
281#define NC_FORMAT_NC3 NC_FORMATX_NC3
282#define NC_FORMAT_NC_HDF5 NC_FORMATX_NC_HDF5
283#define NC_FORMAT_NC4 NC_FORMATX_NC4
284#define NC_FORMAT_NC_HDF4 NC_FORMATX_NC_HDF4
285#define NC_FORMAT_PNETCDF NC_FORMATX_PNETCDF
286#define NC_FORMAT_DAP2 NC_FORMATX_DAP2
287#define NC_FORMAT_DAP4 NC_FORMATX_DAP4
288#define NC_FORMAT_UNDEFINED NC_FORMATX_UNDEFINED
289#define NC_FORMATX_ZARR NC_FORMATX_NCZARR
290
292
294#define NC_SIZEHINT_DEFAULT 0
295
297#define NC_ALIGN_CHUNK ((size_t)(-1))
298
300#define NC_UNLIMITED 0L
301
303#define NC_GLOBAL -1
304
327#define NC_MAX_DIMS 1024 /* not enforced after 4.5.0 */
328#define NC_MAX_ATTRS 8192 /* not enforced after 4.5.0 */
329#define NC_MAX_VARS 8192 /* not enforced after 4.5.0 */
330#define NC_MAX_NAME 256
331#define NC_MAX_VAR_DIMS 1024
333
338#define NC_MAX_HDF4_NAME NC_MAX_NAME
339
343#define NC_ENDIAN_NATIVE 0
344#define NC_ENDIAN_LITTLE 1
345#define NC_ENDIAN_BIG 2
347
353#define NC_CHUNKED 0
354#define NC_CONTIGUOUS 1
355#define NC_COMPACT 2
356#define NC_UNKNOWN_STORAGE 3
357#define NC_VIRTUAL 4
359
365#define NC_NOCHECKSUM 0
366#define NC_FLETCHER32 1
368
374#define NC_NOSHUFFLE 0
375#define NC_SHUFFLE 1
377
378#define NC_MIN_DEFLATE_LEVEL 0
379#define NC_MAX_DEFLATE_LEVEL 9
380
381#define NC_SZIP_NN 32
382#define NC_SZIP_EC 4
383
384#define NC_NOQUANTIZE 0
385#define NC_QUANTIZE_BITGROOM 1
386#define NC_QUANTIZE_GRANULARBR 2
387#define NC_QUANTIZE_BITROUND 3
388
392#define NC_QUANTIZE_BITGROOM_ATT_NAME "_QuantizeBitGroomNumberOfSignificantDigits"
393#define NC_QUANTIZE_GRANULARBR_ATT_NAME "_QuantizeGranularBitRoundNumberOfSignificantDigits"
394#define NC_QUANTIZE_BITROUND_ATT_NAME "_QuantizeBitRoundNumberOfSignificantBits"
396
400#define NC_QUANTIZE_MAX_FLOAT_NSD (6)
401#define NC_QUANTIZE_MAX_FLOAT_NSB (23)
403
407#define NC_QUANTIZE_MAX_DOUBLE_NSD (15)
408#define NC_QUANTIZE_MAX_DOUBLE_NSB (52)
410
415#define NC_ISSYSERR(err) ((err) > 0)
416
417#define NC_NOERR 0
418#define NC2_ERR (-1)
419
424#define NC_EBADID (-33)
425#define NC_ENFILE (-34)
426#define NC_EEXIST (-35)
427#define NC_EINVAL (-36)
428#define NC_EPERM (-37)
429
433#define NC_ENOTINDEFINE (-38)
434
442#define NC_EINDEFINE (-39)
443
449#define NC_EINVALCOORDS (-40)
450
454#define NC_EMAXDIMS (-41) /* not enforced after 4.5.0 */
455
456#define NC_ENAMEINUSE (-42)
457#define NC_ENOTATT (-43)
458#define NC_EMAXATTS (-44)
459#define NC_EBADTYPE (-45)
460#define NC_EBADDIM (-46)
461#define NC_EUNLIMPOS (-47)
462
466#define NC_EMAXVARS (-48) /* not enforced after 4.5.0 */
467
471#define NC_ENOTVAR (-49)
472#define NC_EGLOBAL (-50)
473#define NC_ENOTNC (-51)
474#define NC_ESTS (-52)
475#define NC_EMAXNAME (-53)
476#define NC_EUNLIMIT (-54)
477#define NC_ENORECVARS (-55)
478#define NC_ECHAR (-56)
479
487#define NC_EEDGE (-57)
488#define NC_ESTRIDE (-58)
489#define NC_EBADNAME (-59)
490/* N.B. following must match value in ncx.h */
491
496#define NC_ERANGE (-60)
497#define NC_ENOMEM (-61)
498#define NC_EVARSIZE (-62)
499#define NC_EDIMSIZE (-63)
500#define NC_ETRUNC (-64)
501#define NC_EAXISTYPE (-65)
502
503/* Following errors are added for DAP */
504#define NC_EDAP (-66)
505#define NC_ECURL (-67)
506#define NC_EIO (-68)
507#define NC_ENODATA (-69)
508#define NC_EDAPSVC (-70)
509#define NC_EDAS (-71)
510#define NC_EDDS (-72)
511#define NC_EDMR NC_EDDS
512#define NC_EDATADDS (-73)
513#define NC_EDATADAP NC_EDATADDS
514#define NC_EDAPURL (-74)
515#define NC_EDAPCONSTRAINT (-75)
516#define NC_ETRANSLATION (-76)
517#define NC_EACCESS (-77)
518#define NC_EAUTH (-78)
519
520/* Misc. additional errors */
521#define NC_ENOTFOUND (-90)
522#define NC_ECANTREMOVE (-91)
523#define NC_EINTERNAL (-92)
524#define NC_EPNETCDF (-93)
525
526/* The following was added in support of netcdf-4. Make all netcdf-4
527 error codes < -100 so that errors can be added to netcdf-3 if
528 needed. */
529#define NC4_FIRST_ERROR (-100)
530#define NC_EHDFERR (-101)
531#define NC_ECANTREAD (-102)
532#define NC_ECANTWRITE (-103)
533#define NC_ECANTCREATE (-104)
534#define NC_EFILEMETA (-105)
535#define NC_EDIMMETA (-106)
536#define NC_EATTMETA (-107)
537#define NC_EVARMETA (-108)
538#define NC_ENOCOMPOUND (-109)
539#define NC_EATTEXISTS (-110)
540#define NC_ENOTNC4 (-111)
541#define NC_ESTRICTNC3 (-112)
542#define NC_ENOTNC3 (-113)
543#define NC_ENOPAR (-114)
544#define NC_EPARINIT (-115)
545#define NC_EBADGRPID (-116)
546#define NC_EBADTYPID (-117)
547#define NC_ETYPDEFINED (-118)
548#define NC_EBADFIELD (-119)
549#define NC_EBADCLASS (-120)
550#define NC_EMAPTYPE (-121)
551#define NC_ELATEFILL (-122)
552#define NC_ELATEDEF (-123)
553#define NC_EDIMSCALE (-124)
554#define NC_ENOGRP (-125)
555#define NC_ESTORAGE (-126)
556#define NC_EBADCHUNK (-127)
557#define NC_ENOTBUILT (-128)
558#define NC_EDISKLESS (-129)
559#define NC_ECANTEXTEND (-130)
560#define NC_EMPI (-131)
561
562#define NC_EFILTER (-132)
563#define NC_ERCFILE (-133)
564#define NC_ENULLPAD (-134)
565#define NC_EINMEMORY (-135)
566#define NC_ENOFILTER (-136)
567#define NC_ENCZARR (-137)
568#define NC_ES3 (-138)
569#define NC_EEMPTY (-139)
570#define NC_EOBJECT (-140)
571#define NC_ENOOBJECT (-141)
572#define NC_EPLUGIN (-142)
573#define NC_ENOTZARR (-143)
574#define NC_EZARRMETA (-144)
575
576#define NC4_LAST_ERROR (-144)
577
578/*
579 * Don't forget to update docs/all-error-codes.md if adding new error codes here!
580 *
581 */
582
583/* Errors for all remote access methods(e.g. DAP and CDMREMOTE)*/
584#define NC_EURL (NC_EDAPURL)
585#define NC_ECONSTRAINT (NC_EDAPCONSTRAINT)
586
589#define DIM_WITHOUT_VARIABLE "This is a netCDF dimension but not a netCDF variable."
590
594#define NC_HAVE_NEW_CHUNKING_API 1
595
596/*
597 * The Interface
598 */
599
600/* Declaration modifiers for DLL support (MSC et al) */
601#if defined(DLL_NETCDF) /* define when library is a DLL */
602# if defined(DLL_EXPORT) /* define when building the library */
603# define MSC_EXTRA __declspec(dllexport)
604# else
605# define MSC_EXTRA __declspec(dllimport)
606# endif
607# include <io.h>
608#else
609#define MSC_EXTRA
610#endif /* defined(DLL_NETCDF) */
611
612#define EXTERNL MSC_EXTRA extern
613
614#if defined(DLL_NETCDF) /* define when library is a DLL */
615EXTERNL int ncerr;
616EXTERNL int ncopts;
617#endif
618
619EXTERNL const char *
620nc_inq_libvers(void);
621
622EXTERNL const char *
623nc_strerror(int ncerr);
624
625typedef struct NC_Dispatch NC_Dispatch;
626EXTERNL int
627nc_def_user_format(int mode_flag, NC_Dispatch *dispatch_table, char *magic_number);
628
629EXTERNL int
630nc_inq_user_format(int mode_flag, NC_Dispatch **dispatch_table, char *magic_number);
631
632/* Set the global alignment property */
633EXTERNL int
634nc_set_alignment(int threshold, int alignment);
635
636/* Get the global alignment property */
637EXTERNL int
638nc_get_alignment(int* thresholdp, int* alignmentp);
639
640/* Set the global minimum HDF5 metadata block size property. */
641EXTERNL int
642nc_set_meta_block_size(size_t size);
643
644/* Get the global minimum HDF5 metadata block size property. */
645EXTERNL int
646nc_get_meta_block_size(size_t* sizep);
647
648EXTERNL int
649nc__create(const char *path, int cmode, size_t initialsz,
650 size_t *chunksizehintp, int *ncidp);
651
652EXTERNL int
653nc_create(const char *path, int cmode, int *ncidp);
654
655EXTERNL int
656nc__open(const char *path, int mode,
657 size_t *chunksizehintp, int *ncidp);
658
659EXTERNL int
660nc_open(const char *path, int mode, int *ncidp);
661
662/* Learn the path used to open/create the file. */
663EXTERNL int
664nc_inq_path(int ncid, size_t *pathlen, char *path);
665
666/* Given an ncid and group name (NULL gets root group), return
667 * locid. */
668EXTERNL int
669nc_inq_ncid(int ncid, const char *name, int *grp_ncid);
670
671/* Given a location id, return the number of groups it contains, and
672 * an array of their locids. */
673EXTERNL int
674nc_inq_grps(int ncid, int *numgrps, int *ncids);
675
676/* Given locid, find name of group. (Root group is named "/".) */
677EXTERNL int
678nc_inq_grpname(int ncid, char *name);
679
680/* Given ncid, find full name and len of full name. (Root group is
681 * named "/", with length 1.) */
682EXTERNL int
683nc_inq_grpname_full(int ncid, size_t *lenp, char *full_name);
684
685/* Given ncid, find len of full name. */
686EXTERNL int
687nc_inq_grpname_len(int ncid, size_t *lenp);
688
689/* Given an ncid, find the ncid of its parent group. */
690EXTERNL int
691nc_inq_grp_parent(int ncid, int *parent_ncid);
692
693/* Given a name and parent ncid, find group ncid. */
694EXTERNL int
695nc_inq_grp_ncid(int ncid, const char *grp_name, int *grp_ncid);
696
697/* Given a full name and ncid, find group ncid. */
698EXTERNL int
699nc_inq_grp_full_ncid(int ncid, const char *full_name, int *grp_ncid);
700
701/* Get a list of ids for all the variables in a group. */
702EXTERNL int
703nc_inq_varids(int ncid, int *nvars, int *varids);
704
705/* Find all dimids for a location. This finds all dimensions in a
706 * group, or any of its parents. */
707EXTERNL int
708nc_inq_dimids(int ncid, int *ndims, int *dimids, int include_parents);
709
710/* Find all user-defined types for a location. This finds all
711 * user-defined types in a group. */
712EXTERNL int
713nc_inq_typeids(int ncid, int *ntypes, int *typeids);
714
715/* Are two types equal? */
716EXTERNL int
717nc_inq_type_equal(int ncid1, nc_type typeid1, int ncid2,
718 nc_type typeid2, int *equal);
719
720/* Create a group. its ncid is returned in the new_ncid pointer. */
721EXTERNL int
722nc_def_grp(int parent_ncid, const char *name, int *new_ncid);
723
724/* Rename a group */
725EXTERNL int
726nc_rename_grp(int grpid, const char *name);
727
728/* Here are functions for dealing with compound types. */
729
730/* Create a compound type. */
731EXTERNL int
732nc_def_compound(int ncid, size_t size, const char *name, nc_type *typeidp);
733
734/* Insert a named field into a compound type. */
735EXTERNL int
736nc_insert_compound(int ncid, nc_type xtype, const char *name,
737 size_t offset, nc_type field_typeid);
738
739/* Insert a named array into a compound type. */
740EXTERNL int
741nc_insert_array_compound(int ncid, nc_type xtype, const char *name,
742 size_t offset, nc_type field_typeid,
743 int ndims, const int *dim_sizes);
744
745/* Get the name and size of a type. */
746EXTERNL int
747nc_inq_type(int ncid, nc_type xtype, char *name, size_t *size);
748
749/* Get the id of a type from the name, which might be a fully qualified name */
750EXTERNL int
751nc_inq_typeid(int ncid, const char *name, nc_type *typeidp);
752
753/* Get the name, size, and number of fields in a compound type. */
754EXTERNL int
755nc_inq_compound(int ncid, nc_type xtype, char *name, size_t *sizep,
756 size_t *nfieldsp);
757
758/* Get the name of a compound type. */
759EXTERNL int
760nc_inq_compound_name(int ncid, nc_type xtype, char *name);
761
762/* Get the size of a compound type. */
763EXTERNL int
764nc_inq_compound_size(int ncid, nc_type xtype, size_t *sizep);
765
766/* Get the number of fields in this compound type. */
767EXTERNL int
768nc_inq_compound_nfields(int ncid, nc_type xtype, size_t *nfieldsp);
769
770/* Given the xtype and the fieldid, get all info about it. */
771EXTERNL int
772nc_inq_compound_field(int ncid, nc_type xtype, int fieldid, char *name,
773 size_t *offsetp, nc_type *field_typeidp, int *ndimsp,
774 int *dim_sizesp);
775
776/* Given the typeid and the fieldid, get the name. */
777EXTERNL int
778nc_inq_compound_fieldname(int ncid, nc_type xtype, int fieldid,
779 char *name);
780
781/* Given the xtype and the name, get the fieldid. */
782EXTERNL int
783nc_inq_compound_fieldindex(int ncid, nc_type xtype, const char *name,
784 int *fieldidp);
785
786/* Given the xtype and fieldid, get the offset. */
787EXTERNL int
788nc_inq_compound_fieldoffset(int ncid, nc_type xtype, int fieldid,
789 size_t *offsetp);
790
791/* Given the xtype and the fieldid, get the type of that field. */
792EXTERNL int
793nc_inq_compound_fieldtype(int ncid, nc_type xtype, int fieldid,
794 nc_type *field_typeidp);
795
796/* Given the xtype and the fieldid, get the number of dimensions for
797 * that field (scalars are 0). */
798EXTERNL int
799nc_inq_compound_fieldndims(int ncid, nc_type xtype, int fieldid,
800 int *ndimsp);
801
802/* Given the xtype and the fieldid, get the sizes of dimensions for
803 * that field. User must have allocated storage for the dim_sizes. */
804EXTERNL int
805nc_inq_compound_fielddim_sizes(int ncid, nc_type xtype, int fieldid,
806 int *dim_sizes);
807
809typedef struct {
810 size_t len;
811 void *p;
812} nc_vlen_t;
813
818#define NC_COMPOUND_OFFSET(S,M) (offsetof(S,M))
819
820/* Create a variable length type. */
821EXTERNL int
822nc_def_vlen(int ncid, const char *name, nc_type base_typeid, nc_type *xtypep);
823
824/* Find out about a vlen. */
825EXTERNL int
826nc_inq_vlen(int ncid, nc_type xtype, char *name, size_t *datum_sizep,
827 nc_type *base_nc_typep);
828
829/* Put or get one element in a vlen array. */
830EXTERNL int
831nc_put_vlen_element(int ncid, int typeid1, void *vlen_element,
832 size_t len, const void *data);
833
834EXTERNL int
835nc_get_vlen_element(int ncid, int typeid1, const void *vlen_element,
836 size_t *len, void *data);
837
838/* Find out about a user defined type. */
839EXTERNL int
840nc_inq_user_type(int ncid, nc_type xtype, char *name, size_t *size,
841 nc_type *base_nc_typep, size_t *nfieldsp, int *classp);
842
843/* Write an attribute of any type. */
844EXTERNL int
845nc_put_att(int ncid, int varid, const char *name, nc_type xtype,
846 size_t len, const void *op);
847
848/* Read an attribute of any type. */
849EXTERNL int
850nc_get_att(int ncid, int varid, const char *name, void *ip);
851
852/* Enum type. */
853
854/* Create an enum type. Provide a base type and a name. At the moment
855 * only ints are accepted as base types. */
856EXTERNL int
857nc_def_enum(int ncid, nc_type base_typeid, const char *name,
858 nc_type *typeidp);
859
860/* Insert a named value into an enum type. The value must fit within
861 * the size of the enum type, the name size must be <= NC_MAX_NAME. */
862EXTERNL int
863nc_insert_enum(int ncid, nc_type xtype, const char *name,
864 const void *value);
865
866/* Get information about an enum type: its name, base type and the
867 * number of members defined. */
868EXTERNL int
869nc_inq_enum(int ncid, nc_type xtype, char *name, nc_type *base_nc_typep,
870 size_t *base_sizep, size_t *num_membersp);
871
872/* Get information about an enum member: a name and value. Name size
873 * will be <= NC_MAX_NAME. */
874EXTERNL int
875nc_inq_enum_member(int ncid, nc_type xtype, int idx, char *name,
876 void *value);
877
878
879/* Get enum name from enum value. Name size will be <= NC_MAX_NAME. */
880/* If value is zero and there is no matching ident, then return _UNDEFINED */
881#define NC_UNDEFINED_ENUM_IDENT "_UNDEFINED"
882
883EXTERNL int
884nc_inq_enum_ident(int ncid, nc_type xtype, long long value, char *identifier);
885
886/* Opaque type. */
887
888/* Create an opaque type. Provide a size and a name. */
889EXTERNL int
890nc_def_opaque(int ncid, size_t size, const char *name, nc_type *xtypep);
891
892/* Get information about an opaque type. */
893EXTERNL int
894nc_inq_opaque(int ncid, nc_type xtype, char *name, size_t *sizep);
895
896/* Write entire var of any type. */
897EXTERNL int
898nc_put_var(int ncid, int varid, const void *op);
899
900/* Read entire var of any type. */
901EXTERNL int
902nc_get_var(int ncid, int varid, void *ip);
903
904/* Write one value. */
905EXTERNL int
906nc_put_var1(int ncid, int varid, const size_t *indexp,
907 const void *op);
908
909/* Read one value. */
910EXTERNL int
911nc_get_var1(int ncid, int varid, const size_t *indexp, void *ip);
912
913/* Write an array of values. */
914EXTERNL int
915nc_put_vara(int ncid, int varid, const size_t *startp,
916 const size_t *countp, const void *op);
917
918/* Read an array of values. */
919EXTERNL int
920nc_get_vara(int ncid, int varid, const size_t *startp,
921 const size_t *countp, void *ip);
922
923/* Write slices of an array of values. */
924EXTERNL int
925nc_put_vars(int ncid, int varid, const size_t *startp,
926 const size_t *countp, const ptrdiff_t *stridep,
927 const void *op);
928
929/* Read slices of an array of values. */
930EXTERNL int
931nc_get_vars(int ncid, int varid, const size_t *startp,
932 const size_t *countp, const ptrdiff_t *stridep,
933 void *ip);
934
935/* Write mapped slices of an array of values. */
936EXTERNL int
937nc_put_varm(int ncid, int varid, const size_t *startp,
938 const size_t *countp, const ptrdiff_t *stridep,
939 const ptrdiff_t *imapp, const void *op);
940
941/* Read mapped slices of an array of values. */
942EXTERNL int
943nc_get_varm(int ncid, int varid, const size_t *startp,
944 const size_t *countp, const ptrdiff_t *stridep,
945 const ptrdiff_t *imapp, void *ip);
946
947/* Extra netcdf-4 stuff. */
948
949/* Set quantization settings for a variable. Quantizing data improves
950 * later compression. Must be called after nc_def_var and before
951 * nc_enddef. */
952EXTERNL int
953nc_def_var_quantize(int ncid, int varid, int quantize_mode, int nsd);
954
955/* Find out quantization settings of a var. */
956EXTERNL int
957nc_inq_var_quantize(int ncid, int varid, int *quantize_modep, int *nsdp);
958
959/* Set compression settings for a variable. Lower is faster, higher is
960 * better. Must be called after nc_def_var and before nc_enddef. */
961EXTERNL int
962nc_def_var_deflate(int ncid, int varid, int shuffle, int deflate,
963 int deflate_level);
964
965/* Find out compression settings of a var. */
966EXTERNL int
967nc_inq_var_deflate(int ncid, int varid, int *shufflep,
968 int *deflatep, int *deflate_levelp);
969
970/* Set szip compression for a variable. */
971EXTERNL int nc_def_var_szip(int ncid, int varid, int options_mask,
972 int pixels_per_block);
973
974/* Find out szip settings of a var. */
975EXTERNL int
976nc_inq_var_szip(int ncid, int varid, int *options_maskp, int *pixels_per_blockp);
977
978/* Set fletcher32 checksum for a var. This must be done after nc_def_var
979 and before nc_enddef. */
980EXTERNL int
981nc_def_var_fletcher32(int ncid, int varid, int fletcher32);
982
983/* Inquire about fletcher32 checksum for a var. */
984EXTERNL int
985nc_inq_var_fletcher32(int ncid, int varid, int *fletcher32p);
986
987/* Define chunking for a variable. This must be done after nc_def_var
988 and before nc_enddef. */
989EXTERNL int
990nc_def_var_chunking(int ncid, int varid, int storage, const size_t *chunksizesp);
991
992/* Inq chunking stuff for a var. */
993EXTERNL int
994nc_inq_var_chunking(int ncid, int varid, int *storagep, size_t *chunksizesp);
995
996/* Define fill value behavior for a variable. This must be done after
997 nc_def_var and before nc_enddef. */
998EXTERNL int
999nc_def_var_fill(int ncid, int varid, int no_fill, const void *fill_value);
1000
1001/* Inq fill value setting for a var. */
1002EXTERNL int
1003nc_inq_var_fill(int ncid, int varid, int *no_fill, void *fill_valuep);
1004
1005/* Define the endianness of a variable. */
1006EXTERNL int
1007nc_def_var_endian(int ncid, int varid, int endian);
1008
1009/* Learn about the endianness of a variable. */
1010EXTERNL int
1011nc_inq_var_endian(int ncid, int varid, int *endianp);
1012
1013/* Define a filter for a variable */
1014EXTERNL int
1015nc_def_var_filter(int ncid, int varid, unsigned int id, size_t nparams, const unsigned int* parms);
1016
1017/* Learn about the first filter on a variable */
1018EXTERNL int
1019nc_inq_var_filter(int ncid, int varid, unsigned int* idp, size_t* nparams, unsigned int* params);
1020
1021/* Set the fill mode (classic or 64-bit offset files only). */
1022EXTERNL int
1023nc_set_fill(int ncid, int fillmode, int *old_modep);
1024
1025/* Set the default nc_create format to NC_FORMAT_CLASSIC, NC_FORMAT_64BIT,
1026 * NC_FORMAT_CDF5, NC_FORMAT_NETCDF4, or NC_FORMAT_NETCDF4_CLASSIC */
1027EXTERNL int
1028nc_set_default_format(int format, int *old_formatp);
1029
1030/* Set the cache size, nelems, and preemption policy. */
1031EXTERNL int
1032nc_set_chunk_cache(size_t size, size_t nelems, float preemption);
1033
1034/* Get the cache size, nelems, and preemption policy. */
1035EXTERNL int
1036nc_get_chunk_cache(size_t *sizep, size_t *nelemsp, float *preemptionp);
1037
1038/* Set the per-variable cache size, nelems, and preemption policy. */
1039EXTERNL int
1040nc_set_var_chunk_cache(int ncid, int varid, size_t size, size_t nelems,
1041 float preemption);
1042
1043/* Get the per-variable cache size, nelems, and preemption policy. */
1044EXTERNL int
1045nc_get_var_chunk_cache(int ncid, int varid, size_t *sizep, size_t *nelemsp,
1046 float *preemptionp);
1047
1048EXTERNL int
1049nc_redef(int ncid);
1050
1051/* Is this ever used? Convert to parameter form */
1052EXTERNL int
1053nc__enddef(int ncid, size_t h_minfree, size_t v_align,
1054 size_t v_minfree, size_t r_align);
1055
1056EXTERNL int
1057nc_enddef(int ncid);
1058
1059EXTERNL int
1060nc_sync(int ncid);
1061
1062EXTERNL int
1063nc_abort(int ncid);
1064
1065EXTERNL int
1066nc_close(int ncid);
1067
1068EXTERNL int
1069nc_inq(int ncid, int *ndimsp, int *nvarsp, int *nattsp, int *unlimdimidp);
1070
1071EXTERNL int
1072nc_inq_ndims(int ncid, int *ndimsp);
1073
1074EXTERNL int
1075nc_inq_nvars(int ncid, int *nvarsp);
1076
1077EXTERNL int
1078nc_inq_natts(int ncid, int *nattsp);
1079
1080EXTERNL int
1081nc_inq_unlimdim(int ncid, int *unlimdimidp);
1082
1083/* The next function is for NetCDF-4 only */
1084EXTERNL int
1085nc_inq_unlimdims(int ncid, int *nunlimdimsp, int *unlimdimidsp);
1086
1087/* Added in 3.6.1 to return format of netCDF file. */
1088EXTERNL int
1089nc_inq_format(int ncid, int *formatp);
1090
1091/* Added in 4.3.1 to return additional format info */
1092EXTERNL int
1093nc_inq_format_extended(int ncid, int *formatp, int* modep);
1094
1095/* Begin _dim */
1096
1097EXTERNL int
1098nc_def_dim(int ncid, const char *name, size_t len, int *idp);
1099
1100EXTERNL int
1101nc_inq_dimid(int ncid, const char *name, int *idp);
1102
1103EXTERNL int
1104nc_inq_dim(int ncid, int dimid, char *name, size_t *lenp);
1105
1106EXTERNL int
1107nc_inq_dimname(int ncid, int dimid, char *name);
1108
1109EXTERNL int
1110nc_inq_dimlen(int ncid, int dimid, size_t *lenp);
1111
1112EXTERNL int
1113nc_rename_dim(int ncid, int dimid, const char *name);
1114
1115/* End _dim */
1116/* Begin _att */
1117
1118EXTERNL int
1119nc_inq_att(int ncid, int varid, const char *name,
1120 nc_type *xtypep, size_t *lenp);
1121
1122EXTERNL int
1123nc_inq_attid(int ncid, int varid, const char *name, int *idp);
1124
1125EXTERNL int
1126nc_inq_atttype(int ncid, int varid, const char *name, nc_type *xtypep);
1127
1128EXTERNL int
1129nc_inq_attlen(int ncid, int varid, const char *name, size_t *lenp);
1130
1131EXTERNL int
1132nc_inq_attname(int ncid, int varid, int attnum, char *name);
1133
1134EXTERNL int
1135nc_copy_att(int ncid_in, int varid_in, const char *name, int ncid_out, int varid_out);
1136
1137EXTERNL int
1138nc_rename_att(int ncid, int varid, const char *name, const char *newname);
1139
1140EXTERNL int
1141nc_del_att(int ncid, int varid, const char *name);
1142
1143/* End _att */
1144/* Begin {put,get}_att */
1145EXTERNL int
1146nc_put_att_text(int ncid, int varid, const char *name,
1147 size_t len, const char *op);
1148
1149EXTERNL int
1150nc_get_att_text(int ncid, int varid, const char *name, char *ip);
1151
1152EXTERNL int
1153nc_put_att_string(int ncid, int varid, const char *name,
1154 size_t len, const char **op);
1155
1156EXTERNL int
1157nc_get_att_string(int ncid, int varid, const char *name, char **ip);
1158
1159EXTERNL int
1160nc_put_att_uchar(int ncid, int varid, const char *name, nc_type xtype,
1161 size_t len, const unsigned char *op);
1162
1163EXTERNL int
1164nc_get_att_uchar(int ncid, int varid, const char *name, unsigned char *ip);
1165
1166EXTERNL int
1167nc_put_att_schar(int ncid, int varid, const char *name, nc_type xtype,
1168 size_t len, const signed char *op);
1169
1170EXTERNL int
1171nc_get_att_schar(int ncid, int varid, const char *name, signed char *ip);
1172
1173EXTERNL int
1174nc_put_att_short(int ncid, int varid, const char *name, nc_type xtype,
1175 size_t len, const short *op);
1176
1177EXTERNL int
1178nc_get_att_short(int ncid, int varid, const char *name, short *ip);
1179
1180EXTERNL int
1181nc_put_att_int(int ncid, int varid, const char *name, nc_type xtype,
1182 size_t len, const int *op);
1183
1184EXTERNL int
1185nc_get_att_int(int ncid, int varid, const char *name, int *ip);
1186
1187EXTERNL int
1188nc_put_att_long(int ncid, int varid, const char *name, nc_type xtype,
1189 size_t len, const long *op);
1190
1191EXTERNL int
1192nc_get_att_long(int ncid, int varid, const char *name, long *ip);
1193
1194EXTERNL int
1195nc_put_att_float(int ncid, int varid, const char *name, nc_type xtype,
1196 size_t len, const float *op);
1197
1198EXTERNL int
1199nc_get_att_float(int ncid, int varid, const char *name, float *ip);
1200
1201EXTERNL int
1202nc_put_att_double(int ncid, int varid, const char *name, nc_type xtype,
1203 size_t len, const double *op);
1204
1205EXTERNL int
1206nc_get_att_double(int ncid, int varid, const char *name, double *ip);
1207
1208EXTERNL int
1209nc_put_att_ushort(int ncid, int varid, const char *name, nc_type xtype,
1210 size_t len, const unsigned short *op);
1211
1212EXTERNL int
1213nc_get_att_ushort(int ncid, int varid, const char *name, unsigned short *ip);
1214
1215EXTERNL int
1216nc_put_att_uint(int ncid, int varid, const char *name, nc_type xtype,
1217 size_t len, const unsigned int *op);
1218
1219EXTERNL int
1220nc_get_att_uint(int ncid, int varid, const char *name, unsigned int *ip);
1221
1222EXTERNL int
1223nc_put_att_longlong(int ncid, int varid, const char *name, nc_type xtype,
1224 size_t len, const long long *op);
1225
1226EXTERNL int
1227nc_get_att_longlong(int ncid, int varid, const char *name, long long *ip);
1228
1229EXTERNL int
1230nc_put_att_ulonglong(int ncid, int varid, const char *name, nc_type xtype,
1231 size_t len, const unsigned long long *op);
1232
1233EXTERNL int
1234nc_get_att_ulonglong(int ncid, int varid, const char *name,
1235 unsigned long long *ip);
1236
1237
1238/* End {put,get}_att */
1239/* Begin _var */
1240
1241EXTERNL int
1242nc_def_var(int ncid, const char *name, nc_type xtype, int ndims,
1243 const int *dimidsp, int *varidp);
1244
1245EXTERNL int
1246nc_inq_var(int ncid, int varid, char *name, nc_type *xtypep,
1247 int *ndimsp, int *dimidsp, int *nattsp);
1248
1249EXTERNL int
1250nc_inq_varid(int ncid, const char *name, int *varidp);
1251
1252EXTERNL int
1253nc_inq_varname(int ncid, int varid, char *name);
1254
1255EXTERNL int
1256nc_inq_vartype(int ncid, int varid, nc_type *xtypep);
1257
1258EXTERNL int
1259nc_inq_varndims(int ncid, int varid, int *ndimsp);
1260
1261EXTERNL int
1262nc_inq_vardimid(int ncid, int varid, int *dimidsp);
1263
1264EXTERNL int
1265nc_inq_varnatts(int ncid, int varid, int *nattsp);
1266
1267EXTERNL int
1268nc_rename_var(int ncid, int varid, const char *name);
1269
1270EXTERNL int
1271nc_copy_var(int ncid_in, int varid, int ncid_out);
1272
1273#ifndef ncvarcpy
1274/* support the old name for now */
1275#define ncvarcpy(ncid_in, varid, ncid_out) ncvarcopy((ncid_in), (varid), (ncid_out))
1276#endif
1277
1278/* End _var */
1279/* Begin {put,get}_var1 */
1280
1281EXTERNL int
1282nc_put_var1_text(int ncid, int varid, const size_t *indexp, const char *op);
1283
1284EXTERNL int
1285nc_get_var1_text(int ncid, int varid, const size_t *indexp, char *ip);
1286
1287EXTERNL int
1288nc_put_var1_uchar(int ncid, int varid, const size_t *indexp,
1289 const unsigned char *op);
1290
1291EXTERNL int
1292nc_get_var1_uchar(int ncid, int varid, const size_t *indexp,
1293 unsigned char *ip);
1294
1295EXTERNL int
1296nc_put_var1_schar(int ncid, int varid, const size_t *indexp,
1297 const signed char *op);
1298
1299EXTERNL int
1300nc_get_var1_schar(int ncid, int varid, const size_t *indexp,
1301 signed char *ip);
1302
1303EXTERNL int
1304nc_put_var1_short(int ncid, int varid, const size_t *indexp,
1305 const short *op);
1306
1307EXTERNL int
1308nc_get_var1_short(int ncid, int varid, const size_t *indexp,
1309 short *ip);
1310
1311EXTERNL int
1312nc_put_var1_int(int ncid, int varid, const size_t *indexp, const int *op);
1313
1314EXTERNL int
1315nc_get_var1_int(int ncid, int varid, const size_t *indexp, int *ip);
1316
1317EXTERNL int
1318nc_put_var1_long(int ncid, int varid, const size_t *indexp, const long *op);
1319
1320EXTERNL int
1321nc_get_var1_long(int ncid, int varid, const size_t *indexp, long *ip);
1322
1323EXTERNL int
1324nc_put_var1_float(int ncid, int varid, const size_t *indexp, const float *op);
1325
1326EXTERNL int
1327nc_get_var1_float(int ncid, int varid, const size_t *indexp, float *ip);
1328
1329EXTERNL int
1330nc_put_var1_double(int ncid, int varid, const size_t *indexp, const double *op);
1331
1332EXTERNL int
1333nc_get_var1_double(int ncid, int varid, const size_t *indexp, double *ip);
1334
1335EXTERNL int
1336nc_put_var1_ushort(int ncid, int varid, const size_t *indexp,
1337 const unsigned short *op);
1338
1339EXTERNL int
1340nc_get_var1_ushort(int ncid, int varid, const size_t *indexp,
1341 unsigned short *ip);
1342
1343EXTERNL int
1344nc_put_var1_uint(int ncid, int varid, const size_t *indexp,
1345 const unsigned int *op);
1346
1347EXTERNL int
1348nc_get_var1_uint(int ncid, int varid, const size_t *indexp,
1349 unsigned int *ip);
1350
1351EXTERNL int
1352nc_put_var1_longlong(int ncid, int varid, const size_t *indexp,
1353 const long long *op);
1354
1355EXTERNL int
1356nc_get_var1_longlong(int ncid, int varid, const size_t *indexp,
1357 long long *ip);
1358
1359EXTERNL int
1360nc_put_var1_ulonglong(int ncid, int varid, const size_t *indexp,
1361 const unsigned long long *op);
1362
1363EXTERNL int
1364nc_get_var1_ulonglong(int ncid, int varid, const size_t *indexp,
1365 unsigned long long *ip);
1366
1367EXTERNL int
1368nc_put_var1_string(int ncid, int varid, const size_t *indexp,
1369 const char **op);
1370
1371EXTERNL int
1372nc_get_var1_string(int ncid, int varid, const size_t *indexp,
1373 char **ip);
1374
1375/* End {put,get}_var1 */
1376/* Begin {put,get}_vara */
1377
1378EXTERNL int
1379nc_put_vara_text(int ncid, int varid, const size_t *startp,
1380 const size_t *countp, const char *op);
1381
1382EXTERNL int
1383nc_get_vara_text(int ncid, int varid, const size_t *startp,
1384 const size_t *countp, char *ip);
1385
1386EXTERNL int
1387nc_put_vara_uchar(int ncid, int varid, const size_t *startp,
1388 const size_t *countp, const unsigned char *op);
1389
1390EXTERNL int
1391nc_get_vara_uchar(int ncid, int varid, const size_t *startp,
1392 const size_t *countp, unsigned char *ip);
1393
1394EXTERNL int
1395nc_put_vara_schar(int ncid, int varid, const size_t *startp,
1396 const size_t *countp, const signed char *op);
1397
1398EXTERNL int
1399nc_get_vara_schar(int ncid, int varid, const size_t *startp,
1400 const size_t *countp, signed char *ip);
1401
1402EXTERNL int
1403nc_put_vara_short(int ncid, int varid, const size_t *startp,
1404 const size_t *countp, const short *op);
1405
1406EXTERNL int
1407nc_get_vara_short(int ncid, int varid, const size_t *startp,
1408 const size_t *countp, short *ip);
1409
1410EXTERNL int
1411nc_put_vara_int(int ncid, int varid, const size_t *startp,
1412 const size_t *countp, const int *op);
1413
1414EXTERNL int
1415nc_get_vara_int(int ncid, int varid, const size_t *startp,
1416 const size_t *countp, int *ip);
1417
1418EXTERNL int
1419nc_put_vara_long(int ncid, int varid, const size_t *startp,
1420 const size_t *countp, const long *op);
1421
1422EXTERNL int
1423nc_get_vara_long(int ncid, int varid,
1424 const size_t *startp, const size_t *countp, long *ip);
1425
1426EXTERNL int
1427nc_put_vara_float(int ncid, int varid,
1428 const size_t *startp, const size_t *countp, const float *op);
1429
1430EXTERNL int
1431nc_get_vara_float(int ncid, int varid,
1432 const size_t *startp, const size_t *countp, float *ip);
1433
1434EXTERNL int
1435nc_put_vara_double(int ncid, int varid, const size_t *startp,
1436 const size_t *countp, const double *op);
1437
1438EXTERNL int
1439nc_get_vara_double(int ncid, int varid, const size_t *startp,
1440 const size_t *countp, double *ip);
1441
1442EXTERNL int
1443nc_put_vara_ushort(int ncid, int varid, const size_t *startp,
1444 const size_t *countp, const unsigned short *op);
1445
1446EXTERNL int
1447nc_get_vara_ushort(int ncid, int varid, const size_t *startp,
1448 const size_t *countp, unsigned short *ip);
1449
1450EXTERNL int
1451nc_put_vara_uint(int ncid, int varid, const size_t *startp,
1452 const size_t *countp, const unsigned int *op);
1453
1454EXTERNL int
1455nc_get_vara_uint(int ncid, int varid, const size_t *startp,
1456 const size_t *countp, unsigned int *ip);
1457
1458EXTERNL int
1459nc_put_vara_longlong(int ncid, int varid, const size_t *startp,
1460 const size_t *countp, const long long *op);
1461
1462EXTERNL int
1463nc_get_vara_longlong(int ncid, int varid, const size_t *startp,
1464 const size_t *countp, long long *ip);
1465
1466EXTERNL int
1467nc_put_vara_ulonglong(int ncid, int varid, const size_t *startp,
1468 const size_t *countp, const unsigned long long *op);
1469
1470EXTERNL int
1471nc_get_vara_ulonglong(int ncid, int varid, const size_t *startp,
1472 const size_t *countp, unsigned long long *ip);
1473
1474EXTERNL int
1475nc_put_vara_string(int ncid, int varid, const size_t *startp,
1476 const size_t *countp, const char **op);
1477
1478EXTERNL int
1479nc_get_vara_string(int ncid, int varid, const size_t *startp,
1480 const size_t *countp, char **ip);
1481
1482/* End {put,get}_vara */
1483/* Begin {put,get}_vars */
1484
1485EXTERNL int
1486nc_put_vars_text(int ncid, int varid,
1487 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1488 const char *op);
1489
1490EXTERNL int
1491nc_get_vars_text(int ncid, int varid,
1492 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1493 char *ip);
1494
1495EXTERNL int
1496nc_put_vars_uchar(int ncid, int varid,
1497 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1498 const unsigned char *op);
1499
1500EXTERNL int
1501nc_get_vars_uchar(int ncid, int varid,
1502 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1503 unsigned char *ip);
1504
1505EXTERNL int
1506nc_put_vars_schar(int ncid, int varid,
1507 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1508 const signed char *op);
1509
1510EXTERNL int
1511nc_get_vars_schar(int ncid, int varid,
1512 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1513 signed char *ip);
1514
1515EXTERNL int
1516nc_put_vars_short(int ncid, int varid,
1517 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1518 const short *op);
1519
1520EXTERNL int
1521nc_get_vars_short(int ncid, int varid, const size_t *startp,
1522 const size_t *countp, const ptrdiff_t *stridep,
1523 short *ip);
1524
1525EXTERNL int
1526nc_put_vars_int(int ncid, int varid,
1527 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1528 const int *op);
1529
1530EXTERNL int
1531nc_get_vars_int(int ncid, int varid,
1532 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1533 int *ip);
1534
1535EXTERNL int
1536nc_put_vars_long(int ncid, int varid,
1537 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1538 const long *op);
1539
1540EXTERNL int
1541nc_get_vars_long(int ncid, int varid,
1542 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1543 long *ip);
1544
1545EXTERNL int
1546nc_put_vars_float(int ncid, int varid,
1547 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1548 const float *op);
1549
1550EXTERNL int
1551nc_get_vars_float(int ncid, int varid,
1552 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1553 float *ip);
1554
1555EXTERNL int
1556nc_put_vars_double(int ncid, int varid,
1557 const size_t *startp, const size_t *countp, const ptrdiff_t *stridep,
1558 const double *op);
1559
1560EXTERNL int
1561nc_get_vars_double(int ncid, int varid, const size_t *startp,
1562 const size_t *countp, const ptrdiff_t *stridep,
1563 double *ip);
1564
1565EXTERNL int
1566nc_put_vars_ushort(int ncid, int varid, const size_t *startp,
1567 const size_t *countp, const ptrdiff_t *stridep,
1568 const unsigned short *op);
1569
1570EXTERNL int
1571nc_get_vars_ushort(int ncid, int varid, const size_t *startp,
1572 const size_t *countp, const ptrdiff_t *stridep,
1573 unsigned short *ip);
1574
1575EXTERNL int
1576nc_put_vars_uint(int ncid, int varid, const size_t *startp,
1577 const size_t *countp, const ptrdiff_t *stridep,
1578 const unsigned int *op);
1579
1580EXTERNL int
1581nc_get_vars_uint(int ncid, int varid, const size_t *startp,
1582 const size_t *countp, const ptrdiff_t *stridep,
1583 unsigned int *ip);
1584
1585EXTERNL int
1586nc_put_vars_longlong(int ncid, int varid, const size_t *startp,
1587 const size_t *countp, const ptrdiff_t *stridep,
1588 const long long *op);
1589
1590EXTERNL int
1591nc_get_vars_longlong(int ncid, int varid, const size_t *startp,
1592 const size_t *countp, const ptrdiff_t *stridep,
1593 long long *ip);
1594
1595EXTERNL int
1596nc_put_vars_ulonglong(int ncid, int varid, const size_t *startp,
1597 const size_t *countp, const ptrdiff_t *stridep,
1598 const unsigned long long *op);
1599
1600EXTERNL int
1601nc_get_vars_ulonglong(int ncid, int varid, const size_t *startp,
1602 const size_t *countp, const ptrdiff_t *stridep,
1603 unsigned long long *ip);
1604
1605EXTERNL int
1606nc_put_vars_string(int ncid, int varid, const size_t *startp,
1607 const size_t *countp, const ptrdiff_t *stridep,
1608 const char **op);
1609
1610EXTERNL int
1611nc_get_vars_string(int ncid, int varid, const size_t *startp,
1612 const size_t *countp, const ptrdiff_t *stridep,
1613 char **ip);
1614
1615/* End {put,get}_vars */
1616/* Begin {put,get}_varm */
1617
1618EXTERNL int
1619nc_put_varm_text(int ncid, int varid, const size_t *startp,
1620 const size_t *countp, const ptrdiff_t *stridep,
1621 const ptrdiff_t *imapp, const char *op);
1622
1623EXTERNL int
1624nc_get_varm_text(int ncid, int varid, const size_t *startp,
1625 const size_t *countp, const ptrdiff_t *stridep,
1626 const ptrdiff_t *imapp, char *ip);
1627
1628EXTERNL int
1629nc_put_varm_uchar(int ncid, int varid, const size_t *startp,
1630 const size_t *countp, const ptrdiff_t *stridep,
1631 const ptrdiff_t *imapp, const unsigned char *op);
1632
1633EXTERNL int
1634nc_get_varm_uchar(int ncid, int varid, const size_t *startp,
1635 const size_t *countp, const ptrdiff_t *stridep,
1636 const ptrdiff_t *imapp, unsigned char *ip);
1637
1638EXTERNL int
1639nc_put_varm_schar(int ncid, int varid, const size_t *startp,
1640 const size_t *countp, const ptrdiff_t *stridep,
1641 const ptrdiff_t *imapp, const signed char *op);
1642
1643EXTERNL int
1644nc_get_varm_schar(int ncid, int varid, const size_t *startp,
1645 const size_t *countp, const ptrdiff_t *stridep,
1646 const ptrdiff_t *imapp, signed char *ip);
1647
1648EXTERNL int
1649nc_put_varm_short(int ncid, int varid, const size_t *startp,
1650 const size_t *countp, const ptrdiff_t *stridep,
1651 const ptrdiff_t *imapp, const short *op);
1652
1653EXTERNL int
1654nc_get_varm_short(int ncid, int varid, const size_t *startp,
1655 const size_t *countp, const ptrdiff_t *stridep,
1656 const ptrdiff_t *imapp, short *ip);
1657
1658EXTERNL int
1659nc_put_varm_int(int ncid, int varid, const size_t *startp,
1660 const size_t *countp, const ptrdiff_t *stridep,
1661 const ptrdiff_t *imapp, const int *op);
1662
1663EXTERNL int
1664nc_get_varm_int(int ncid, int varid, const size_t *startp,
1665 const size_t *countp, const ptrdiff_t *stridep,
1666 const ptrdiff_t *imapp, int *ip);
1667
1668EXTERNL int
1669nc_put_varm_long(int ncid, int varid, const size_t *startp,
1670 const size_t *countp, const ptrdiff_t *stridep,
1671 const ptrdiff_t *imapp, const long *op);
1672
1673EXTERNL int
1674nc_get_varm_long(int ncid, int varid, const size_t *startp,
1675 const size_t *countp, const ptrdiff_t *stridep,
1676 const ptrdiff_t *imapp, long *ip);
1677
1678EXTERNL int
1679nc_put_varm_float(int ncid, int varid,const size_t *startp,
1680 const size_t *countp, const ptrdiff_t *stridep,
1681 const ptrdiff_t *imapp, const float *op);
1682
1683EXTERNL int
1684nc_get_varm_float(int ncid, int varid,const size_t *startp,
1685 const size_t *countp, const ptrdiff_t *stridep,
1686 const ptrdiff_t *imapp, float *ip);
1687
1688EXTERNL int
1689nc_put_varm_double(int ncid, int varid, const size_t *startp,
1690 const size_t *countp, const ptrdiff_t *stridep,
1691 const ptrdiff_t *imapp, const double *op);
1692
1693EXTERNL int
1694nc_get_varm_double(int ncid, int varid, const size_t *startp,
1695 const size_t *countp, const ptrdiff_t *stridep,
1696 const ptrdiff_t * imapp, double *ip);
1697
1698EXTERNL int
1699nc_put_varm_ushort(int ncid, int varid, const size_t *startp,
1700 const size_t *countp, const ptrdiff_t *stridep,
1701 const ptrdiff_t * imapp, const unsigned short *op);
1702
1703EXTERNL int
1704nc_get_varm_ushort(int ncid, int varid, const size_t *startp,
1705 const size_t *countp, const ptrdiff_t *stridep,
1706 const ptrdiff_t * imapp, unsigned short *ip);
1707
1708EXTERNL int
1709nc_put_varm_uint(int ncid, int varid, const size_t *startp,
1710 const size_t *countp, const ptrdiff_t *stridep,
1711 const ptrdiff_t * imapp, const unsigned int *op);
1712
1713EXTERNL int
1714nc_get_varm_uint(int ncid, int varid, const size_t *startp,
1715 const size_t *countp, const ptrdiff_t *stridep,
1716 const ptrdiff_t * imapp, unsigned int *ip);
1717
1718EXTERNL int
1719nc_put_varm_longlong(int ncid, int varid, const size_t *startp,
1720 const size_t *countp, const ptrdiff_t *stridep,
1721 const ptrdiff_t * imapp, const long long *op);
1722
1723EXTERNL int
1724nc_get_varm_longlong(int ncid, int varid, const size_t *startp,
1725 const size_t *countp, const ptrdiff_t *stridep,
1726 const ptrdiff_t * imapp, long long *ip);
1727
1728EXTERNL int
1729nc_put_varm_ulonglong(int ncid, int varid, const size_t *startp,
1730 const size_t *countp, const ptrdiff_t *stridep,
1731 const ptrdiff_t * imapp, const unsigned long long *op);
1732
1733EXTERNL int
1734nc_get_varm_ulonglong(int ncid, int varid, const size_t *startp,
1735 const size_t *countp, const ptrdiff_t *stridep,
1736 const ptrdiff_t * imapp, unsigned long long *ip);
1737
1738EXTERNL int
1739nc_put_varm_string(int ncid, int varid, const size_t *startp,
1740 const size_t *countp, const ptrdiff_t *stridep,
1741 const ptrdiff_t * imapp, const char **op);
1742
1743EXTERNL int
1744nc_get_varm_string(int ncid, int varid, const size_t *startp,
1745 const size_t *countp, const ptrdiff_t *stridep,
1746 const ptrdiff_t * imapp, char **ip);
1747
1748/* End {put,get}_varm */
1749/* Begin {put,get}_var */
1750
1751EXTERNL int
1752nc_put_var_text(int ncid, int varid, const char *op);
1753
1754EXTERNL int
1755nc_get_var_text(int ncid, int varid, char *ip);
1756
1757EXTERNL int
1758nc_put_var_uchar(int ncid, int varid, const unsigned char *op);
1759
1760EXTERNL int
1761nc_get_var_uchar(int ncid, int varid, unsigned char *ip);
1762
1763EXTERNL int
1764nc_put_var_schar(int ncid, int varid, const signed char *op);
1765
1766EXTERNL int
1767nc_get_var_schar(int ncid, int varid, signed char *ip);
1768
1769EXTERNL int
1770nc_put_var_short(int ncid, int varid, const short *op);
1771
1772EXTERNL int
1773nc_get_var_short(int ncid, int varid, short *ip);
1774
1775EXTERNL int
1776nc_put_var_int(int ncid, int varid, const int *op);
1777
1778EXTERNL int
1779nc_get_var_int(int ncid, int varid, int *ip);
1780
1781EXTERNL int
1782nc_put_var_long(int ncid, int varid, const long *op);
1783
1784EXTERNL int
1785nc_get_var_long(int ncid, int varid, long *ip);
1786
1787EXTERNL int
1788nc_put_var_float(int ncid, int varid, const float *op);
1789
1790EXTERNL int
1791nc_get_var_float(int ncid, int varid, float *ip);
1792
1793EXTERNL int
1794nc_put_var_double(int ncid, int varid, const double *op);
1795
1796EXTERNL int
1797nc_get_var_double(int ncid, int varid, double *ip);
1798
1799EXTERNL int
1800nc_put_var_ushort(int ncid, int varid, const unsigned short *op);
1801
1802EXTERNL int
1803nc_get_var_ushort(int ncid, int varid, unsigned short *ip);
1804
1805EXTERNL int
1806nc_put_var_uint(int ncid, int varid, const unsigned int *op);
1807
1808EXTERNL int
1809nc_get_var_uint(int ncid, int varid, unsigned int *ip);
1810
1811EXTERNL int
1812nc_put_var_longlong(int ncid, int varid, const long long *op);
1813
1814EXTERNL int
1815nc_get_var_longlong(int ncid, int varid, long long *ip);
1816
1817EXTERNL int
1818nc_put_var_ulonglong(int ncid, int varid, const unsigned long long *op);
1819
1820EXTERNL int
1821nc_get_var_ulonglong(int ncid, int varid, unsigned long long *ip);
1822
1823EXTERNL int
1824nc_put_var_string(int ncid, int varid, const char **op);
1825
1826EXTERNL int
1827nc_get_var_string(int ncid, int varid, char **ip);
1828
1829/* Begin instance walking functions */
1830
1831/* When you read an array of string typed instances, the library will allocate
1832 * the storage space for the strings in the array (but not the array itself).
1833 * The strings must be freed eventually, so pass the pointer to the array plus
1834 * the number of elements in the array to this function when you're done with
1835 * the data, and it will free the all the string instances.
1836 * The caller is still responsible for free'ing the array itself,
1837 * if it was dynamically allocated.
1838 */
1839EXTERNL int
1840nc_free_string(size_t nelems, char **data);
1841
1842/* When you read an array of VLEN typed instances, the library will allocate
1843 * the storage space for the data in each VLEN in the array (but not the array itself).
1844 * That VLEN data must be freed eventually, so pass the pointer to the array plus
1845 * the number of elements in the array to this function when you're done with
1846 * the data, and it will free the all the VLEN instances.
1847 * The caller is still responsible for free'ing the array itself,
1848 * if it was dynamically allocated.
1849 *
1850 * WARNING: this function only works if the basetype of the vlen type
1851 * is fixed size. This means it is an atomic type except NC_STRING,
1852 * or an NC_ENUM, or and NC_OPAQUE, or an NC_COMPOUND where all
1853 * the fields of the compound type are themselves fixed size.
1854 */
1855EXTERNL int
1856nc_free_vlens(size_t nelems, nc_vlen_t vlens[]);
1857
1858/* This function is a special case of "nc_free_vlens" where nelem == 1 */
1859EXTERNL int
1861
1879
1880EXTERNL int nc_reclaim_data(int ncid, nc_type xtypeid, void* memory, size_t nelems);
1881EXTERNL int nc_reclaim_data_all(int ncid, nc_type xtypeid, void* memory, size_t nelems);
1882
1895
1896EXTERNL int nc_copy_data(int ncid, nc_type xtypeid, const void* memory, size_t count, void* copy);
1897EXTERNL int nc_copy_data_all(int ncid, nc_type xtypeid, const void* memory, size_t count, void** copyp);
1898
1899/* end recursive instance walking functions */
1900
1901/* Begin Deprecated, same as functions with "_ubyte" replaced by "_uchar" */
1902EXTERNL int
1903nc_put_att_ubyte(int ncid, int varid, const char *name, nc_type xtype,
1904 size_t len, const unsigned char *op);
1905EXTERNL int
1906nc_get_att_ubyte(int ncid, int varid, const char *name,
1907 unsigned char *ip);
1908EXTERNL int
1909nc_put_var1_ubyte(int ncid, int varid, const size_t *indexp,
1910 const unsigned char *op);
1911EXTERNL int
1912nc_get_var1_ubyte(int ncid, int varid, const size_t *indexp,
1913 unsigned char *ip);
1914EXTERNL int
1915nc_put_vara_ubyte(int ncid, int varid, const size_t *startp,
1916 const size_t *countp, const unsigned char *op);
1917EXTERNL int
1918nc_get_vara_ubyte(int ncid, int varid, const size_t *startp,
1919 const size_t *countp, unsigned char *ip);
1920EXTERNL int
1921nc_put_vars_ubyte(int ncid, int varid, const size_t *startp,
1922 const size_t *countp, const ptrdiff_t *stridep,
1923 const unsigned char *op);
1924EXTERNL int
1925nc_get_vars_ubyte(int ncid, int varid, const size_t *startp,
1926 const size_t *countp, const ptrdiff_t *stridep,
1927 unsigned char *ip);
1928EXTERNL int
1929nc_put_varm_ubyte(int ncid, int varid, const size_t *startp,
1930 const size_t *countp, const ptrdiff_t *stridep,
1931 const ptrdiff_t * imapp, const unsigned char *op);
1932EXTERNL int
1933nc_get_varm_ubyte(int ncid, int varid, const size_t *startp,
1934 const size_t *countp, const ptrdiff_t *stridep,
1935 const ptrdiff_t * imapp, unsigned char *ip);
1936EXTERNL int
1937nc_put_var_ubyte(int ncid, int varid, const unsigned char *op);
1938
1939EXTERNL int
1940nc_get_var_ubyte(int ncid, int varid, unsigned char *ip);
1941
1942/* End Deprecated */
1943
1944/* Set the log level. 0 shows only errors, 1 only major messages,
1945 * etc., to 5, which shows way too much information. */
1946EXTERNL int
1947nc_set_log_level(int new_level);
1948
1949/* Use this to turn off logging by calling
1950 nc_log_level(NC_TURN_OFF_LOGGING) */
1951#define NC_TURN_OFF_LOGGING (-1)
1952
1953/* Show the netCDF library's in-memory metadata for a file. */
1954EXTERNL int
1955nc_show_metadata(int ncid);
1956
1957/* End {put,get}_var */
1958
1959/* Delete a file. */
1960EXTERNL int
1961nc_delete(const char *path);
1962
1963/*
1964 * The following functions were written to accommodate the old Cray
1965 * systems. Modern HPC systems do not use these functions any more,
1966 * but use the nc_open_par()/nc_create_par() functions instead. These
1967 * functions are retained for backward compatibibility. These
1968 * functions work as advertised, but you can only use "processor
1969 * element" 0.
1970 */
1971
1972EXTERNL int
1973nc__create_mp(const char *path, int cmode, size_t initialsz, int basepe,
1974 size_t *chunksizehintp, int *ncidp);
1975
1976EXTERNL int
1977nc__open_mp(const char *path, int mode, int basepe,
1978 size_t *chunksizehintp, int *ncidp);
1979
1980EXTERNL int
1981nc_delete_mp(const char *path, int basepe);
1982
1983EXTERNL int
1984nc_set_base_pe(int ncid, int pe);
1985
1986EXTERNL int
1987nc_inq_base_pe(int ncid, int *pe);
1988
1989/* This v2 function is used in the nc_test program. */
1990EXTERNL int
1991nctypelen(nc_type datatype);
1992
1993/* Begin v2.4 backward compatibility */
1994
1997#define FILL_BYTE NC_FILL_BYTE
1998#define FILL_CHAR NC_FILL_CHAR
1999#define FILL_SHORT NC_FILL_SHORT
2000#define FILL_LONG NC_FILL_INT
2001#define FILL_FLOAT NC_FILL_FLOAT
2002#define FILL_DOUBLE NC_FILL_DOUBLE
2003
2004#define MAX_NC_DIMS NC_MAX_DIMS
2005#define MAX_NC_ATTRS NC_MAX_ATTRS
2006#define MAX_NC_VARS NC_MAX_VARS
2007#define MAX_NC_NAME NC_MAX_NAME
2008#define MAX_VAR_DIMS NC_MAX_VAR_DIMS
2010
2011
2012/*
2013 * Global error status
2014 */
2015EXTERNL int ncerr;
2016
2017#define NC_ENTOOL NC_EMAXNAME
2018#define NC_EXDR (-32)
2019#define NC_SYSERR (-31)
2020
2021/*
2022 * Global options variable.
2023 * Used to determine behavior of error handler.
2024 */
2025#define NC_FATAL 1
2026#define NC_VERBOSE 2
2027
2030
2031EXTERNL void
2032nc_advise(const char *cdf_routine_name, int err, const char *fmt,...);
2033
2039typedef int nclong;
2040
2041EXTERNL int
2042nccreate(const char* path, int cmode);
2043
2044EXTERNL int
2045ncopen(const char* path, int mode);
2046
2047EXTERNL int
2048ncsetfill(int ncid, int fillmode);
2049
2050EXTERNL int
2051ncredef(int ncid);
2052
2053EXTERNL int
2054ncendef(int ncid);
2055
2056EXTERNL int
2057ncsync(int ncid);
2058
2059EXTERNL int
2060ncabort(int ncid);
2061
2062EXTERNL int
2063ncclose(int ncid);
2064
2065EXTERNL int
2066ncinquire(int ncid, int *ndimsp, int *nvarsp, int *nattsp, int *unlimdimp);
2067
2068EXTERNL int
2069ncdimdef(int ncid, const char *name, long len);
2070
2071EXTERNL int
2072ncdimid(int ncid, const char *name);
2073
2074EXTERNL int
2075ncdiminq(int ncid, int dimid, char *name, long *lenp);
2076
2077EXTERNL int
2078ncdimrename(int ncid, int dimid, const char *name);
2079
2080EXTERNL int
2081ncattput(int ncid, int varid, const char *name, nc_type xtype,
2082 int len, const void *op);
2083
2084EXTERNL int
2085ncattinq(int ncid, int varid, const char *name, nc_type *xtypep, int *lenp);
2086
2087EXTERNL int
2088ncattget(int ncid, int varid, const char *name, void *ip);
2089
2090EXTERNL int
2091ncattcopy(int ncid_in, int varid_in, const char *name, int ncid_out,
2092 int varid_out);
2093
2094EXTERNL int
2095ncattname(int ncid, int varid, int attnum, char *name);
2096
2097EXTERNL int
2098ncattrename(int ncid, int varid, const char *name, const char *newname);
2099
2100EXTERNL int
2101ncattdel(int ncid, int varid, const char *name);
2102
2103EXTERNL int
2104ncvardef(int ncid, const char *name, nc_type xtype,
2105 int ndims, const int *dimidsp);
2106
2107EXTERNL int
2108ncvarid(int ncid, const char *name);
2109
2110EXTERNL int
2111ncvarinq(int ncid, int varid, char *name, nc_type *xtypep,
2112 int *ndimsp, int *dimidsp, int *nattsp);
2113
2114EXTERNL int
2115ncvarput1(int ncid, int varid, const long *indexp, const void *op);
2116
2117EXTERNL int
2118ncvarget1(int ncid, int varid, const long *indexp, void *ip);
2119
2120EXTERNL int
2121ncvarput(int ncid, int varid, const long *startp, const long *countp,
2122 const void *op);
2123
2124EXTERNL int
2125ncvarget(int ncid, int varid, const long *startp, const long *countp,
2126 void *ip);
2127
2128EXTERNL int
2129ncvarputs(int ncid, int varid, const long *startp, const long *countp,
2130 const long *stridep, const void *op);
2131
2132EXTERNL int
2133ncvargets(int ncid, int varid, const long *startp, const long *countp,
2134 const long *stridep, void *ip);
2135
2136EXTERNL int
2137ncvarputg(int ncid, int varid, const long *startp, const long *countp,
2138 const long *stridep, const long *imapp, const void *op);
2139
2140EXTERNL int
2141ncvargetg(int ncid, int varid, const long *startp, const long *countp,
2142 const long *stridep, const long *imapp, void *ip);
2143
2144EXTERNL int
2145ncvarrename(int ncid, int varid, const char *name);
2146
2147EXTERNL int
2148ncrecinq(int ncid, int *nrecvarsp, int *recvaridsp, long *recsizesp);
2149
2150EXTERNL int
2151ncrecget(int ncid, long recnum, void **datap);
2152
2153EXTERNL int
2154ncrecput(int ncid, long recnum, void *const *datap);
2155
2156/* This function may be called to force the library to
2157 initialize itself. It is not required, however.
2158*/
2159EXTERNL int nc_initialize(void);
2160
2161/* This function may be called to force the library to
2162 cleanup global memory so that memory checkers will not
2163 report errors. It is not required, however.
2164*/
2165EXTERNL int nc_finalize(void);
2166
2167/* Programmatic access to the internal .rc table */
2168
2169/* Get the value corresponding to key | return NULL; caller frees result */
2170EXTERNL char* nc_rc_get(const char* key);
2171
2172/* Set/overwrite the value corresponding to key */
2173EXTERNL int nc_rc_set(const char* key, const char* value);
2174
2175#if defined(__cplusplus)
2176}
2177#endif
2178
2179/* Define two hard-coded functionality-related
2180 (as requested by community developers) macros.
2181 This is not going to be standard practice.
2182 Don't remove without an in-place replacement of some sort,
2183 the are now (for better or worse) used by downstream
2184 software external to Unidata. */
2185#ifndef NC_HAVE_RENAME_GRP
2186#define NC_HAVE_RENAME_GRP
2187#endif
2188
2189#ifndef NC_HAVE_INQ_FORMAT_EXTENDED
2190#define NC_HAVE_INQ_FORMAT_EXTENDED
2191#endif
2192
2193#define NC_HAVE_META_H
2194
2195#endif /* _NETCDF_ */
EXTERNL int nc_get_att_int(int ncid, int varid, const char *name, int *ip)
Get an attribute array of type int.
Definition dattget.c:354
EXTERNL int nc_get_att_string(int ncid, int varid, const char *name, char **ip)
Get an attribute array of type string.
Definition dattget.c:711
EXTERNL int nc_put_att(int ncid, int varid, const char *name, nc_type xtype, size_t len, const void *op)
Write an attribute of any type.
Definition dattput.c:222
EXTERNL int nc_get_att(int ncid, int varid, const char *name, void *ip)
Get an attribute of any type.
Definition dattget.c:133
EXTERNL int nc_get_att_float(int ncid, int varid, const char *name, float *ip)
Get an attribute array of type float.
Definition dattget.c:420
EXTERNL int nc_get_att_long(int ncid, int varid, const char *name, long *ip)
Get an attribute array of type long.
Definition dattget.c:387
EXTERNL int nc_get_att_uchar(int ncid, int varid, const char *name, unsigned char *ip)
Get an attribute of an signed char type.
Definition dattget.c:288
EXTERNL int nc_inq_attid(int ncid, int varid, const char *name, int *idp)
Find an attribute ID.
Definition dattinq.c:164
EXTERNL int nc_get_att_longlong(int ncid, int varid, const char *name, long long *ip)
Get an attribute array of type long long.
Definition dattget.c:585
EXTERNL int nc_put_att_uint(int ncid, int varid, const char *name, nc_type xtype, size_t len, const unsigned int *op)
Write an attribute of type unsigned int.
Definition dattput.c:562
EXTERNL int nc_get_att_ubyte(int ncid, int varid, const char *name, unsigned char *ip)
Get an attribute array of type unsigned char.
Definition dattget.c:486
EXTERNL int nc_put_att_string(int ncid, int varid, const char *name, size_t len, const char **op)
Write a string attribute.
Definition dattput.c:75
EXTERNL int nc_inq_natts(int ncid, int *nattsp)
Find number of global or group attributes.
Definition dattinq.c:300
EXTERNL int nc_put_att_ubyte(int ncid, int varid, const char *name, nc_type xtype, size_t len, const unsigned char *op)
Write an attribute of type unsigned char.
Definition dattput.c:494
EXTERNL int nc_put_att_text(int ncid, int varid, const char *name, size_t len, const char *op)
Write a text attribute.
Definition dattput.c:153
EXTERNL int nc_put_att_schar(int ncid, int varid, const char *name, nc_type xtype, size_t len, const signed char *op)
Write an attribute of type signed char.
Definition dattput.c:256
EXTERNL int nc_put_att_ushort(int ncid, int varid, const char *name, nc_type xtype, size_t len, const unsigned short *op)
Write an attribute of type unsigned short.
Definition dattput.c:528
EXTERNL int nc_put_att_long(int ncid, int varid, const char *name, nc_type xtype, size_t len, const long *op)
Write an attribute of type long.
Definition dattput.c:392
EXTERNL int nc_put_att_float(int ncid, int varid, const char *name, nc_type xtype, size_t len, const float *op)
Write an attribute of type float.
Definition dattput.c:426
EXTERNL int nc_put_att_uchar(int ncid, int varid, const char *name, nc_type xtype, size_t len, const unsigned char *op)
Write an attribute of type unsigned char.
Definition dattput.c:290
EXTERNL int nc_get_att_ulonglong(int ncid, int varid, const char *name, unsigned long long *ip)
Get an attribute array of type unsigned long long.
Definition dattget.c:618
EXTERNL int nc_get_att_text(int ncid, int varid, const char *name, char *ip)
Get a text attribute.
Definition dattget.c:222
EXTERNL int nc_get_att_short(int ncid, int varid, const char *name, short *ip)
Get an attribute array of type short.
Definition dattget.c:321
EXTERNL int nc_inq_att(int ncid, int varid, const char *name, nc_type *xtypep, size_t *lenp)
Return information about a netCDF attribute.
Definition dattinq.c:86
EXTERNL int nc_get_att_schar(int ncid, int varid, const char *name, signed char *ip)
Get an attribute of an signed char type.
Definition dattget.c:255
EXTERNL int nc_put_att_longlong(int ncid, int varid, const char *name, nc_type xtype, size_t len, const long long *op)
Write an attribute of type long long.
Definition dattput.c:596
EXTERNL int nc_get_att_double(int ncid, int varid, const char *name, double *ip)
Get an attribute array of type double.
Definition dattget.c:453
EXTERNL int nc_inq_atttype(int ncid, int varid, const char *name, nc_type *xtypep)
Find the type of an attribute.
Definition dattinq.c:358
EXTERNL int nc_put_att_ulonglong(int ncid, int varid, const char *name, nc_type xtype, size_t len, const unsigned long long *op)
Write an attribute of type unsigned long long.
Definition dattput.c:631
EXTERNL int nc_put_att_int(int ncid, int varid, const char *name, nc_type xtype, size_t len, const int *op)
Write an attribute of type int.
Definition dattput.c:358
EXTERNL int nc_del_att(int ncid, int varid, const char *name)
Delete an attribute.
Definition datt.c:177
EXTERNL int nc_rename_att(int ncid, int varid, const char *name, const char *newname)
Rename an attribute.
Definition datt.c:113
EXTERNL int nc_get_att_ushort(int ncid, int varid, const char *name, unsigned short *ip)
Get an attribute array of type unsigned short.
Definition dattget.c:519
EXTERNL int nc_put_att_short(int ncid, int varid, const char *name, nc_type xtype, size_t len, const short *op)
Write an attribute of type short.
Definition dattput.c:324
EXTERNL int nc_inq_attname(int ncid, int varid, int attnum, char *name)
Find the name of an attribute.
Definition dattinq.c:255
EXTERNL int nc_inq_attlen(int ncid, int varid, const char *name, size_t *lenp)
Find the length of an attribute.
Definition dattinq.c:424
EXTERNL int nc_get_att_uint(int ncid, int varid, const char *name, unsigned int *ip)
Get an attribute array of type unsigned int.
Definition dattget.c:552
EXTERNL int nc_put_att_double(int ncid, int varid, const char *name, nc_type xtype, size_t len, const double *op)
Write an attribute of type double.
Definition dattput.c:460
EXTERNL int nc_inq_user_format(int mode_flag, NC_Dispatch **dispatch_table, char *magic_number)
Inquire about user-defined format.
Definition dfile.c:216
EXTERNL int nc__create(const char *path, int cmode, size_t initialsz, size_t *chunksizehintp, int *ncidp)
Create a netCDF file with some extra parameters controlling classic file caching.
Definition dfile.c:500
EXTERNL int nc_close(int ncid)
Close an open netCDF dataset.
Definition dfile.c:1330
EXTERNL int nc_abort(int ncid)
No longer necessary for user to invoke manually.
Definition dfile.c:1277
EXTERNL int nc_create(const char *path, int cmode, int *ncidp)
Create a new netCDF file.
Definition dfile.c:428
EXTERNL int nc_inq(int ncid, int *ndimsp, int *nvarsp, int *nattsp, int *unlimdimidp)
Inquire about a file or group.
Definition dfile.c:1665
EXTERNL int nc_inq_format_extended(int ncid, int *formatp, int *modep)
Obtain more detailed (vis-a-vis nc_inq_format) format information about an open dataset.
Definition dfile.c:1612
EXTERNL int nc__enddef(int ncid, size_t h_minfree, size_t v_align, size_t v_minfree, size_t r_align)
Leave define mode with performance tuning.
Definition dfile.c:1148
EXTERNL int nc_set_fill(int ncid, int fillmode, int *old_modep)
Change the fill-value mode to improve write performance.
Definition dfile.c:1504
EXTERNL int nc__open(const char *path, int mode, size_t *chunksizehintp, int *ncidp)
Open a netCDF file with extra performance parameters for the classic library.
Definition dfile.c:751
EXTERNL int nc_inq_path(int ncid, size_t *pathlen, char *path)
Get the file pathname (or the opendap URL) which was used to open/create the ncid's file.
Definition dfile.c:928
EXTERNL int nc_def_user_format(int mode_flag, NC_Dispatch *dispatch_table, char *magic_number)
Add handling of user-defined format.
Definition dfile.c:166
EXTERNL int nc_get_chunk_cache(size_t *sizep, size_t *nelemsp, float *preemptionp)
Get current netCDF chunk cache settings.
Definition nc4cache.c:95
EXTERNL int nc_inq_type(int ncid, nc_type xtype, char *name, size_t *size)
Inquire about a type.
Definition dfile.c:1758
EXTERNL int nc_enddef(int ncid)
Leave define mode.
Definition dfile.c:1057
EXTERNL int nc_redef(int ncid)
Put open netcdf dataset into define mode.
Definition dfile.c:993
EXTERNL int nc_open(const char *path, int mode, int *ncidp)
Open an existing netCDF file.
Definition dfile.c:694
EXTERNL int nc_set_chunk_cache(size_t size, size_t nelems, float preemption)
Set chunk cache size.
Definition nc4cache.c:66
EXTERNL int nc_inq_format(int ncid, int *formatp)
Inquire about the binary format of a netCDF file as presented by the API.
Definition dfile.c:1577
EXTERNL int nc_sync(int ncid)
Synchronize an open netcdf dataset to disk.
Definition dfile.c:1225
EXTERNL int nc_inq_ndims(int ncid, int *ndimsp)
Find the number of dimensions.
Definition ddim.c:317
EXTERNL int nc_inq_dimlen(int ncid, int dimid, size_t *lenp)
Find the length of a dimension.
Definition ddim.c:467
EXTERNL int nc_inq_dimname(int ncid, int dimid, char *name)
Find out the name of a dimension.
Definition ddim.c:409
EXTERNL int nc_def_dim(int ncid, const char *name, size_t len, int *idp)
Define a new dimension.
Definition ddim.c:121
EXTERNL int nc_rename_dim(int ncid, int dimid, const char *name)
Rename a dimension.
Definition ddim.c:285
EXTERNL int nc_inq_dim(int ncid, int dimid, char *name, size_t *lenp)
Find the name and length of a dimension.
Definition ddim.c:216
EXTERNL int nc_inq_unlimdim(int ncid, int *unlimdimidp)
Find the ID of the unlimited dimension.
Definition ddim.c:350
EXTERNL int nc_inq_dimid(int ncid, const char *name, int *idp)
Find the ID of a dimension from the name.
Definition ddim.c:152
EXTERNL const char * nc_strerror(int ncerr)
Given an error number, return an error message.
Definition derror.c:87
EXTERNL int nc_inq_typeids(int ncid, int *ntypes, int *typeids)
Retrieve a list of types associated with a group.
Definition dgroup.c:245
EXTERNL int nc_inq_dimids(int ncid, int *ndims, int *dimids, int include_parents)
Retrieve a list of dimension ids associated with a group.
Definition dgroup.c:226
EXTERNL int nc_inq_grps(int ncid, int *numgrps, int *ncids)
Get a list of groups or subgroups from a file or groupID.
Definition dgroup.c:76
EXTERNL int nc_show_metadata(int ncid)
Print the metadata for a file.
Definition dgroup.c:333
EXTERNL int nc_inq_grp_full_ncid(int ncid, const char *full_name, int *grp_ncid)
Get the full ncid given a group name.
Definition dgroup.c:188
EXTERNL int nc_inq_grpname(int ncid, char *name)
Get the name of a group given an ID.
Definition dgroup.c:93
EXTERNL int nc_inq_ncid(int ncid, const char *name, int *grp_ncid)
Return the group ID for a group given the name.
Definition dgroup.c:58
EXTERNL int nc_inq_varids(int ncid, int *nvars, int *varids)
Get a list of varids associated with a group given a group ID.
Definition dgroup.c:207
EXTERNL int nc_inq_grp_parent(int ncid, int *parent_ncid)
Get the ID of the parent based on a group ID.
Definition dgroup.c:147
EXTERNL int nc_inq_grpname_len(int ncid, size_t *lenp)
Get the length of a group name given an ID.
Definition dgroup.c:131
EXTERNL int nc_inq_grpname_full(int ncid, size_t *lenp, char *full_name)
Get the full path/groupname of a group/subgroup given an ID.
Definition dgroup.c:113
EXTERNL int nc_def_grp(int parent_ncid, const char *name, int *new_ncid)
Define a new group.
Definition dgroup.c:296
EXTERNL int nc_rename_grp(int grpid, const char *name)
Rename a group.
Definition dgroup.c:317
EXTERNL int nc_inq_grp_ncid(int ncid, const char *grp_name, int *grp_ncid)
Get a group ncid given the group name.
Definition dgroup.c:170
EXTERNL int nc_def_enum(int ncid, nc_type base_typeid, const char *name, nc_type *typeidp)
Create an enum type.
Definition denum.c:43
EXTERNL int nc_inq_compound_fieldtype(int ncid, nc_type xtype, int fieldid, nc_type *field_typeidp)
Get information about one of the fields of a compound type.
Definition dcompound.c:383
EXTERNL int nc_inq_type_equal(int ncid1, nc_type typeid1, int ncid2, nc_type typeid2, int *equal)
Learn if two types are equal.
Definition dtype.c:69
EXTERNL int nc_inq_compound(int ncid, nc_type xtype, char *name, size_t *sizep, size_t *nfieldsp)
Learn about a compound type.
Definition dcompound.c:175
EXTERNL int nc_inq_enum_member(int ncid, nc_type xtype, int idx, char *name, void *value)
Learn about a member of an enum type.
Definition denum.c:140
EXTERNL int nc_insert_compound(int ncid, nc_type xtype, const char *name, size_t offset, nc_type field_typeid)
Insert a named field into a compound type.
Definition dcompound.c:99
EXTERNL int nc_def_opaque(int ncid, size_t size, const char *name, nc_type *xtypep)
Create an opaque type.
Definition dopaque.c:33
EXTERNL int nc_inq_compound_name(int ncid, nc_type xtype, char *name)
Learn the name of a compound type.
Definition dcompound.c:203
EXTERNL int nc_inq_compound_field(int ncid, nc_type xtype, int fieldid, char *name, size_t *offsetp, nc_type *field_typeidp, int *ndimsp, int *dim_sizesp)
Get information about one of the fields of a compound type.
Definition dcompound.c:287
EXTERNL int nc_def_vlen(int ncid, const char *name, nc_type base_typeid, nc_type *xtypep)
Use this function to define a variable length array type.
Definition dvlen.c:92
EXTERNL int nc_inq_compound_fielddim_sizes(int ncid, nc_type xtype, int fieldid, int *dim_sizes)
Get information about one of the fields of a compound type.
Definition dcompound.c:443
EXTERNL int nc_free_vlen(nc_vlen_t *vl)
Free memory in a single VLEN object.
Definition dvlen.c:60
EXTERNL int nc_inq_vlen(int ncid, nc_type xtype, char *name, size_t *datum_sizep, nc_type *base_nc_typep)
Learn about a VLEN type.
Definition dvlen.c:120
EXTERNL int nc_inq_opaque(int ncid, nc_type xtype, char *name, size_t *sizep)
Learn about an opaque type.
Definition dopaque.c:61
EXTERNL int nc_free_vlens(size_t nelems, nc_vlen_t vlens[])
Free an array of vlens given the number of elements and an array.
Definition dvlen.c:39
EXTERNL int nc_def_compound(int ncid, size_t size, const char *name, nc_type *typeidp)
Create a compound type.
Definition dcompound.c:63
EXTERNL int nc_inq_compound_fieldindex(int ncid, nc_type xtype, const char *name, int *fieldidp)
Learn the Index of a Named Field in a Compound Type.
Definition dcompound.c:475
EXTERNL int nc_inq_compound_fieldndims(int ncid, nc_type xtype, int fieldid, int *ndimsp)
Get information about one of the fields of a compound type.
Definition dcompound.c:413
EXTERNL int nc_inq_compound_nfields(int ncid, nc_type xtype, size_t *nfieldsp)
Learn the number of fields in a compound type.
Definition dcompound.c:249
EXTERNL int nc_insert_enum(int ncid, nc_type xtype, const char *name, const void *value)
Insert a named member into a enum type.
Definition denum.c:71
EXTERNL int nc_inq_typeid(int ncid, const char *name, nc_type *typeidp)
Find a type by name.
Definition dtype.c:102
EXTERNL int nc_insert_array_compound(int ncid, nc_type xtype, const char *name, size_t offset, nc_type field_typeid, int ndims, const int *dim_sizes)
Insert a named array field into a compound type.
Definition dcompound.c:141
EXTERNL int nc_inq_enum(int ncid, nc_type xtype, char *name, nc_type *base_nc_typep, size_t *base_sizep, size_t *num_membersp)
Learn about a user-defined enumeration type.
Definition denum.c:107
EXTERNL int nc_inq_enum_ident(int ncid, nc_type xtype, long long value, char *identifier)
Get the name which is associated with an enum member value.
Definition denum.c:164
EXTERNL int nc_inq_compound_fieldoffset(int ncid, nc_type xtype, int fieldid, size_t *offsetp)
Get information about one of the fields of a compound type.
Definition dcompound.c:353
EXTERNL int nc_inq_compound_fieldname(int ncid, nc_type xtype, int fieldid, char *name)
Get information about one of the fields of a compound type.
Definition dcompound.c:321
EXTERNL int nc_inq_compound_size(int ncid, nc_type xtype, size_t *sizep)
Learn the size of a compound type.
Definition dcompound.c:226
EXTERNL int nc_inq_user_type(int ncid, nc_type xtype, char *name, size_t *size, nc_type *base_nc_typep, size_t *nfieldsp, int *classp)
Learn about a user defined type.
Definition dtype.c:146
EXTERNL int ncvardef(int ncid, const char *name, nc_type xtype, int ndims, const int *dimidsp)
Define a variable.
Definition dv2i.c:856
EXTERNL int ncclose(int ncid)
Close a file.
Definition dv2i.c:606
EXTERNL int ncvarputg(int ncid, int varid, const long *startp, const long *countp, const long *stridep, const long *imapp, const void *op)
Write mapped data.
Definition dv2i.c:1231
EXTERNL int ncattget(int ncid, int varid, const char *name, void *ip)
Read an attribute.
Definition dv2i.c:1479
EXTERNL int ncattinq(int ncid, int varid, const char *name, nc_type *xtypep, int *lenp)
Learn about an attribute.
Definition dv2i.c:1440
EXTERNL int ncattrename(int ncid, int varid, const char *name, const char *newname)
Rename an attribute.
Definition dv2i.c:1574
EXTERNL int ncattname(int ncid, int varid, int attnum, char *name)
Learn attribute name from its number.
Definition dv2i.c:1543
EXTERNL int ncvarput1(int ncid, int varid, const long *indexp, const void *op)
Write 1 data value.
Definition dv2i.c:965
EXTERNL int ncvarid(int ncid, const char *name)
Learn a variable ID from the name.
Definition dv2i.c:887
EXTERNL int nccreate(const char *path, int cmode)
Create a netCDF file.
Definition dv2i.c:511
EXTERNL int ncendef(int ncid)
End define mode for file.
Definition dv2i.c:583
EXTERNL int ncopen(const char *path, int mode)
Open a netCDF file.
Definition dv2i.c:536
EXTERNL int ncrecput(int ncid, long recnum, void *const *datap)
Write one record's worth of data, except don't write to variables for which the address of the data t...
Definition dv2i.c:1754
EXTERNL int ncattcopy(int ncid_in, int varid_in, const char *name, int ncid_out, int varid_out)
Copy an attribute.
Definition dv2i.c:1511
EXTERNL int ncdimrename(int ncid, int dimid, const char *name)
Rename a dimension.
Definition dv2i.c:825
EXTERNL int ncattdel(int ncid, int varid, const char *name)
Delete an attribute.
Definition dv2i.c:1604
EXTERNL int ncvarputs(int ncid, int varid, const long *startp, const long *countp, const long *stridep, const void *op)
Write strided data.
Definition dv2i.c:1125
EXTERNL int ncvarput(int ncid, int varid, const long *startp, const long *countp, const void *op)
Write some data.
Definition dv2i.c:1040
EXTERNL int ncdiminq(int ncid, int dimid, char *name, long *lenp)
Learn about a dimension.
Definition dv2i.c:788
EXTERNL int ncvarget1(int ncid, int varid, const long *indexp, void *ip)
Read 1 data value.
Definition dv2i.c:1002
EXTERNL int ncvargetg(int ncid, int varid, const long *startp, const long *countp, const long *stridep, const long *imapp, void *ip)
Read mapped data.
Definition dv2i.c:1304
EXTERNL int ncinquire(int ncid, int *ndimsp, int *nvarsp, int *nattsp, int *unlimdimp)
Learn about a file.
Definition dv2i.c:635
EXTERNL int ncvarinq(int ncid, int varid, char *name, nc_type *xtypep, int *ndimsp, int *dimidsp, int *nattsp)
Learn about a variable.
Definition dv2i.c:920
EXTERNL int ncattput(int ncid, int varid, const char *name, nc_type xtype, int len, const void *op)
Write an attribute.
Definition dv2i.c:1405
EXTERNL void nc_advise(const char *cdf_routine_name, int err, const char *fmt,...)
Show an error message and exit (based on ncopts).
Definition dv2i.c:466
EXTERNL int ncabort(int ncid)
Abort defining a file.
Definition dv2i.c:700
EXTERNL int ncsync(int ncid)
Sync a file.
Definition dv2i.c:677
EXTERNL int ncrecinq(int ncid, int *nrecvarsp, int *recvaridsp, long *recsizesp)
Learn record variables and the lengths of the record dimension.
Definition dv2i.c:1666
EXTERNL int ncrecget(int ncid, long recnum, void **datap)
Read one record's worth of data, except don't read from variables for which the address of the data t...
Definition dv2i.c:1723
EXTERNL int ncsetfill(int ncid, int fillmode)
Set the fill mode.
Definition dv2i.c:1636
EXTERNL int ncdimdef(int ncid, const char *name, long len)
Define a dimension.
Definition dv2i.c:726
EXTERNL int ncvarget(int ncid, int varid, const long *startp, const long *countp, void *ip)
Read some data.
Definition dv2i.c:1082
EXTERNL int ncvargets(int ncid, int varid, const long *startp, const long *countp, const long *stridep, void *ip)
Read strided data.
Definition dv2i.c:1178
EXTERNL int ncredef(int ncid)
Put file in define mode.
Definition dv2i.c:560
EXTERNL int ncvarrename(int ncid, int varid, const char *name)
Rename a variable.
Definition dv2i.c:1373
EXTERNL int ncdimid(int ncid, const char *name)
Find dimension ID from name.
Definition dv2i.c:761
EXTERNL int nc_inq_var_endian(int ncid, int varid, int *endianp)
Find the endianness of a variable.
Definition dvarinq.c:583
EXTERNL int nc_inq_varndims(int ncid, int varid, int *ndimsp)
Learn how many dimensions are associated with a variable.
Definition dvarinq.c:202
EXTERNL int nc_def_var_endian(int ncid, int varid, int endian)
Define endianness of a variable.
Definition dvar.c:810
EXTERNL int nc_inq_varname(int ncid, int varid, char *name)
Learn the name of a variable.
Definition dvarinq.c:156
EXTERNL int nc_free_string(size_t nelems, char **data)
Free string space allocated by the library.
Definition dvar.c:1320
EXTERNL int nc_inq_var_quantize(int ncid, int varid, int *quantize_modep, int *nsdp)
Learn whether quantization is on for a variable, and, if so, the NSD setting.
Definition dvarinq.c:546
EXTERNL int nc_def_var_szip(int ncid, int varid, int options_mask, int pixels_per_block)
Set szip compression settings on a variable.
Definition dvar.c:868
EXTERNL int nc_inq_var_deflate(int ncid, int varid, int *shufflep, int *deflatep, int *deflate_levelp)
Learn the shuffle and deflate settings for a variable.
Definition dvarinq.c:295
EXTERNL int nc_get_vars(int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, void *ip)
Read a strided array from a variable.
Definition dvarget.c:1173
EXTERNL int nc_set_var_chunk_cache(int ncid, int varid, size_t size, size_t nelems, float preemption)
Change the cache settings for a chunked variable.
Definition dvar.c:1398
EXTERNL int nc_inq_vartype(int ncid, int varid, nc_type *xtypep)
Learn the type of a variable.
Definition dvarinq.c:178
EXTERNL int nc_inq_var_fletcher32(int ncid, int varid, int *fletcher32p)
Learn the checksum settings for a variable.
Definition dvarinq.c:378
EXTERNL int nc_inq_varid(int ncid, const char *name, int *varidp)
Find the ID of a variable, from the name.
Definition dvarinq.c:60
EXTERNL int nc_put_varm(int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, const ptrdiff_t *imapp, const void *op)
Write a mapped array of values to a variable.
Definition dvarput.c:1243
EXTERNL int nc_inq_varnatts(int ncid, int varid, int *nattsp)
Learn how many attributes are associated with a variable.
Definition dvarinq.c:249
EXTERNL int nc_put_var(int ncid, int varid, const void *op)
Write an entire variable with one call.
Definition dvarput.c:922
EXTERNL int nc_get_vara(int ncid, int varid, const size_t *startp, const size_t *countp, void *ip)
Read an array of values from a variable.
Definition dvarget.c:746
EXTERNL int nc_def_var_deflate(int ncid, int varid, int shuffle, int deflate, int deflate_level)
Set the zlib compression and shuffle settings for a variable in an netCDF/HDF5 file.
Definition dvar.c:463
EXTERNL int nc_put_vars(int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, const void *op)
Write a strided array of values to a variable.
Definition dvarput.c:1048
EXTERNL int nc_def_var_fletcher32(int ncid, int varid, int fletcher32)
Set checksum for a var.
Definition dvar.c:612
EXTERNL int nc_def_var_quantize(int ncid, int varid, int quantize_mode, int nsd)
Turn on quantization for a variable.
Definition dvar.c:563
EXTERNL int nc_get_var(int ncid, int varid, void *ip)
Read an entire variable in one call.
Definition dvarget.c:1038
EXTERNL int nc_get_varm(int ncid, int varid, const size_t *startp, const size_t *countp, const ptrdiff_t *stridep, const ptrdiff_t *imapp, void *ip)
Read a mapped array from a variable.
Definition dvarget.c:1370
EXTERNL int nc_inq_var(int ncid, int varid, char *name, nc_type *xtypep, int *ndimsp, int *dimidsp, int *nattsp)
Learn about a variable.
Definition dvarinq.c:124
EXTERNL int nc_inq_var_szip(int ncid, int varid, int *options_maskp, int *pixels_per_blockp)
Learn the szip settings of a variable.
Definition dvarinq.c:733
EXTERNL int nc_inq_var_filter(int ncid, int varid, unsigned int *idp, size_t *nparams, unsigned int *params)
Find the first filter (if any) associated with a variable.
Definition dfilter.c:170
EXTERNL int nc_inq_vardimid(int ncid, int varid, int *dimidsp)
Learn the dimension IDs associated with a variable.
Definition dvarinq.c:225
EXTERNL int nc_get_var1(int ncid, int varid, const size_t *indexp, void *ip)
Read a single datum from a variable.
Definition dvarget.c:894
EXTERNL int nc_def_var_fill(int ncid, int varid, int no_fill, const void *fill_value)
Set the fill value for a variable.
Definition dvar.c:311
EXTERNL int nc_inq_var_chunking(int ncid, int varid, int *storagep, size_t *chunksizesp)
Get the storage and (for chunked variables) the chunksizes of a variable.
Definition dvarinq.c:466
EXTERNL int nc_def_var(int ncid, const char *name, nc_type xtype, int ndims, const int *dimidsp, int *varidp)
Define a new variable.
Definition dvar.c:216
EXTERNL int nc_rename_var(int ncid, int varid, const char *name)
Rename a variable.
Definition dvar.c:948
EXTERNL int nc_put_var1(int ncid, int varid, const size_t *indexp, const void *op)
Write one datum.
Definition dvarput.c:783
EXTERNL int nc_put_vara(int ncid, int varid, const size_t *startp, const size_t *countp, const void *op)
Write an array of values to a variable.
Definition dvarput.c:633
EXTERNL int nc_def_var_chunking(int ncid, int varid, int storage, const size_t *chunksizesp)
Define storage and, if chunked storage is used, chunking parameters for a variable.
Definition dvar.c:732
EXTERNL int nc_get_var_chunk_cache(int ncid, int varid, size_t *sizep, size_t *nelemsp, float *preemptionp)
Get the per-variable chunk cache settings from the HDF5 layer.
Definition dvar.c:1439
EXTERNL int nc_inq_var_fill(int ncid, int varid, int *no_fill, void *fill_valuep)
Learn the fill mode of a variable.
Definition dvarinq.c:502
EXTERNL int nc_inq_nvars(int ncid, int *nvarsp)
Learn the number of variables in a file or group.
Definition dfile.c:1684
EXTERNL const char * nc_inq_libvers(void)
Return the library version.
Definition derror.c:27
void * p
Pointer to VL data.
Definition netcdf.h:811
EXTERNL int nc_reclaim_data(int ncid, nc_type xtypeid, void *memory, size_t nelems)
Reclaim an array of instances of an arbitrary type.
size_t len
Length of VL data (in base type units).
Definition netcdf.h:810
EXTERNL int nc_inq_unlimdims(int ncid, int *nunlimdimsp, int *unlimdimidsp)
Return number and list of unlimited dimensions.
Definition dvarinq.c:673
#define EXTERNL
Needed for DLL build.
Definition netcdf.h:612
EXTERNL int ncopts
V2 API error handling.
Definition netcdf.h:2029
EXTERNL int nc_copy_data(int ncid, nc_type xtypeid, const void *memory, size_t count, void *copy)
Copy vector of arbitrary type instances.
int nclong
C data type corresponding to a netCDF NC_LONG argument, a signed 32 bit object.
Definition netcdf.h:2039
EXTERNL int nc_copy_att(int ncid_in, int varid_in, const char *name, int ncid_out, int varid_out)
Copy an attribute from one open file to another.
Definition dcopy.c:587
EXTERNL int nc_copy_var(int ncid_in, int varid, int ncid_out)
This will copy a variable that is an array of primitive type and its attributes from one file to anot...
Definition dcopy.c:282
EXTERNL int nc_def_var_filter(int ncid, int varid, unsigned int id, size_t nparams, const unsigned int *parms)
Define a new variable filter Assumes HDF5 format using unsigned ints.
Definition dfilter.c:129
int nc_type
The nc_type type is just an int.
Definition netcdf.h:25
This is the type of arrays of vlens.
Definition netcdf.h:809