1/*! \file
2  Functions for VLEN Types
3
4  Copyright 2011 University Corporation for Atmospheric
5  Research/Unidata. See \ref copyright file for more info. */
6
7#include "ncdispatch.h"
8
9/** \name Variable Length Array Types
10
11    Functions to create and learn about VLEN types. */
12/*! \{ */ /* All these functions are part of this named group... */
13
14/**
15\ingroup user_types
16Free memory in a VLEN object.
17
18When you read VLEN type the library will actually allocate the storage
19space for the data. This storage space must be freed, so pass the
20pointer back to this function, when you're done with the data, and it
21will free the vlen memory.
22
23The function nc_free_vlens() is more useful than this function,
24because it can free an array of VLEN objects.
25
26\param vl pointer to the vlen object.
27
28\returns ::NC_NOERR No error.
29*/
30int
31nc_free_vlen(nc_vlen_t *vl)
32{
33   free(vl->p);
34   return NC_NOERR;
35}
36
37/**
38\ingroup user_types
39Free an array of vlens given the number of elements and an array.
40
41When you read VLEN type the library will actually allocate the storage
42space for the data. This storage space must be freed, so pass the
43pointer back to this function, when you're done with the data, and it
44will free the vlen memory.
45
46\param len number of elements in the array.
47\param vlens pointer to the vlen object.
48
49\returns ::NC_NOERR No error.
50*/
51int
52nc_free_vlens(size_t lennc_vlen_t vlens[])
53{
54   int ret;
55   size_t i;
56
57   for(i = 0; i < leni++)
58      if ((ret = nc_free_vlen(&vlens[i])))
59  return ret;
60
61   return NC_NOERR;
62}
63
64/**
65\ingroup user_types
66Use this function to define a variable length array type.
67
68\param ncid \ref ncid
69\param name \ref object_name of new type.
70
71\param base_typeid The typeid of the base type of the VLEN. For
72example, for a VLEN of shorts, the base type is ::NC_SHORT. This can be
73a user defined type.
74
75\param xtypep A pointer to an nc_type variable. The typeid of the new
76VLEN type will be set here.
77
78\returns ::NC_NOERR No error.
79\returns ::NC_EBADID Bad \ref ncid.
80\returns ::NC_EBADTYPE Bad type id.
81\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
82\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
83\returns ::NC_ENAMEINUSE That name is in use.
84\returns ::NC_EMAXNAME Name exceeds max length NC_MAX_NAME.
85\returns ::NC_EBADNAME Name contains illegal characters.
86\returns ::NC_EPERM Attempt to write to a read-only file.
87\returns ::NC_ENOTINDEFINE Not in define mode.
88 */
89int
90nc_def_vlen(int ncid, const char *namenc_type base_typeidnc_type *xtypep)
91{
92    NCncp;
93    int stat = NC_check_id(ncid,&ncp);
94    if(stat != NC_NOERR) return stat;
95    return ncp->dispatch->def_vlen(ncid,name,base_typeid,xtypep);
96}
97
98/** \ingroup user_types
99Learn about a VLEN type.
100
101\param ncid \ref ncid
102\param xtype The type of the VLEN to inquire about.
103\param name \ref object_name of the type. \ref ignored_if_null.
104
105\param datum_sizep A pointer to a size_t, this will get the size of
106one element of this vlen. \ref ignored_if_null.
107
108\param base_nc_typep Pointer to get the base type of the VLEN. \ref
109ignored_if_null.
110
111\returns ::NC_NOERR No error.
112\returns ::NC_EBADID Bad \ref ncid.
113\returns ::NC_EBADTYPE Bad type id.
114\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
115\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
116 */
117int
118nc_inq_vlen(int ncidnc_type xtype, char *name, size_t *datum_sizepnc_type *base_nc_typep)
119{
120    int class = 0;
121    int stat = nc_inq_user_type(ncid,xtype,name,datum_sizep,base_nc_typep,NULL,&class);
122    if(stat != NC_NOERR) return stat;
123    if(class != NC_VLENstat = NC_EBADTYPE;
124    return stat;
125}
126/*! \} */  /* End of named group ...*/
127
128/** \internal
129\ingroup user_types
130
131Put a VLEN element. This function writes an element of a VLEN for the
132Fortran APIs.
133
134\param ncid \ref ncid
135\param typeid1 Typeid of the VLEN.
136\param vlen_element Pointer to the element of the VLEN.
137\param len Lenth of the VLEN element.
138\param data VLEN data.
139
140\returns ::NC_NOERR No error.
141\returns ::NC_EBADID Bad \ref ncid.
142\returns ::NC_EBADTYPE Bad type id.
143\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
144\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
145\returns ::NC_EPERM Attempt to write to a read-only file.
146 */
147int
148nc_put_vlen_element(int ncid, int typeid1, void *vlen_element, size_t len, const void *data)
149{
150    NCncp;
151    int stat = NC_check_id(ncid,&ncp);
152    if(stat != NC_NOERR) return stat;
153    return ncp->dispatch->put_vlen_element(ncid,typeid1,vlen_element,len,data);
154}
155
156/**
157\internal
158\ingroup user_types
159
160Get a VLEN element. This function reads an element of a VLEN for the
161Fortran APIs.
162
163\param ncid \ref ncid
164\param typeid1 Typeid of the VLEN.
165\param vlen_element Pointer to the element of the VLEN.
166\param len Lenth of the VLEN element.
167\param data VLEN data.
168
169\returns ::NC_NOERR No error.
170\returns ::NC_EBADID Bad \ref ncid.
171\returns ::NC_EBADTYPE Bad type id.
172\returns ::NC_ENOTNC4 Not an netCDF-4 file, or classic model enabled.
173\returns ::NC_EHDFERR An error was reported by the HDF5 layer.
174 */
175int
176nc_get_vlen_element(int ncid, int typeid1, const void *vlen_element,
177     size_t *len, void *data)
178{
179    NC *ncp;
180    int stat = NC_check_id(ncid,&ncp);
181    if(stat != NC_NOERR) return stat;
182    return ncp->dispatch->get_vlen_element(ncidtypeid1vlen_element,
183    lendata);
184}


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