1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
|
/****************************************************************************
* NCSA HDF *
* Software Development Group *
* National Center for Supercomputing Applications *
* University of Illinois at Urbana-Champaign *
* 605 E. Springfield, Champaign IL 61820 *
* *
* For conditions of distribution and use, see the accompanying *
* hdf/COPYING file. *
* *
****************************************************************************/
#ifdef RCSID
static char RcsId[] = "@(#)$Revision$";
#endif
/* $Id$ */
/*LINTLIBRARY */
/*+
FILE
H5P.c
HDF5 Data-space routines
EXPORTED ROUTINES
H5Pcreate -- Create a data-space
H5Prelease -- Release access to a data-space
LIBRARY-SCOPED ROUTINES
LOCAL ROUTINES
H5P_init_interface -- initialize the interface
+ */
#include <H5private.h> /* Generic Functions */
#include <H5Aprivate.h> /* Atom Functions */
#include <H5Eprivate.h> /* Error handling */
#include <H5Pprivate.h> /* Data-space functions */
#define PABLO_MASK H5P_mask
/*--------------------- Locally scoped variables -----------------------------*/
/* Whether we've installed the library termination function yet for this interface */
static intn interface_initialize_g = FALSE;
/*--------------------------------------------------------------------------
NAME
H5P_init_interface -- Initialize interface-specific information
USAGE
herr_t H5P_init_interface()
RETURNS
SUCCEED/FAIL
DESCRIPTION
Initializes any interface-specific data or routines.
--------------------------------------------------------------------------*/
static herr_t H5P_init_interface(void)
{
herr_t ret_value = SUCCEED;
FUNC_ENTER (H5P_init_interface, NULL, FAIL);
/* Initialize the atom group for the file IDs */
ret_value=H5Ainit_group(H5_DATASPACE,H5A_DATASPACEID_HASHSIZE,H5P_RESERVED_ATOMS);
FUNC_LEAVE(ret_value);
} /* H5P_init_interface */
/*--------------------------------------------------------------------------
NAME
H5P_create
PURPOSE
Create a new HDF5 dimensionality object
USAGE
hatom_t H5P_create(owner_id, type, name)
hatom_t owner_id; IN: Group/file which owns this object
hobjtype_t type; IN: Type of object to create
const char *name; IN: Name of the object
RETURNS
Returns ID (atom) on success, FAIL on failure
DESCRIPTION
This function actually creates the dimensionality object.
--------------------------------------------------------------------------*/
hatom_t H5P_create(hatom_t owner_id, hobjtype_t type, const char *name)
{
H5P_dim_t *new_dim; /* new dimensionality object to create */
hatom_t ret_value = SUCCEED;
FUNC_ENTER(H5P_create, H5P_init_interface, FAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
/* Allocate space for the new data-type */
if((new_dim=HDmalloc(sizeof(H5P_dim_t)))==NULL)
HGOTO_ERROR(H5E_RESOURCE, H5E_NOSPACE, FAIL);
/* Initialize the dimensionality object */
new_dim->rank=0;
new_dim->dims=NULL;
/* Register the new datatype and get an ID for it */
if((ret_value=H5Aregister_atom(H5_DATASPACE, (const VOIDP)new_dim))==FAIL)
HGOTO_ERROR(H5E_ATOM, H5E_CANTREGISTER, FAIL);
done:
if(ret_value == FAIL)
{ /* Error condition cleanup */
} /* end if */
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5P_create() */
/*--------------------------------------------------------------------------
NAME
H5P_get_lrank
PURPOSE
Return the logical rank of a dataspace (internal)
USAGE
uint32 H5P_get_lrank(sdim)
H5P_sdim_t *sdim; IN: Pointer to dataspace object to query
RETURNS
The logical rank of a dataspace on success, UFAIL on failure
DESCRIPTION
This function determines the number of logical dimensions in a
dataspace. The logical rank is the actual number of dimensions of the
dataspace, not the dimensionality of the space its embedded in.
UFAIL is returned on an error, otherwise the rank is returned.
--------------------------------------------------------------------------*/
uint32 H5P_get_lrank(H5P_sdim_t *sdim)
{
uint32 ret_value = UFAIL;
FUNC_ENTER(H5P_get_lrank, H5P_init_interface, UFAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
assert(sdim);
ret_value=sdim->rank;
#ifdef LATER
done:
#endif /* LATER */
if(ret_value == UFAIL)
{ /* Error condition cleanup */
} /* end if */
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5P_get_lrank() */
/*--------------------------------------------------------------------------
NAME
H5P_is_simple
PURPOSE
Check if a dataspace is simple (internal)
USAGE
hbool_t H5P_is_simple(sdim)
H5P_sdim_t *sdim; IN: Pointer to dataspace object to query
RETURNS
BTRUE/BFALSE/BFAIL
DESCRIPTION
This function determines the if a dataspace is "simple". ie. if it
has orthogonal, evenly spaced dimensions.
--------------------------------------------------------------------------*/
hbool_t H5P_is_simple(H5P_sdim_t *sdim)
{
hbool_t ret_value = BFAIL;
FUNC_ENTER(H5P_get_lrank, H5P_init_interface, UFAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
assert(sdim);
ret_value=BTRUE; /* Currently all dataspaces are simple */
#ifdef LATER
done:
#endif /* LATER */
if(ret_value == BFAIL)
{ /* Error condition cleanup */
} /* end if */
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5P_is_simple() */
/*--------------------------------------------------------------------------
NAME
H5Pnelem
PURPOSE
Return the number of elements in a dataspace
USAGE
uintn H5Pnelem(sid)
hatom_t sid; IN: Dataspace object to query
RETURNS
The number of elements in a dataspace on success, UFAIL on failure
DESCRIPTION
This function determines the number of dataset elements in a
dataspace. For example, a simple 3-dimensional dataspace with dimensions
2, 3 and 4 would have 24 elements.
UFAIL is returned on an error, otherwise the number of elements is returned.
--------------------------------------------------------------------------*/
uintn H5Pnelem(hatom_t sid)
{
uintn ret_value = UFAIL;
FUNC_ENTER(H5Pnelem, H5P_init_interface, UFAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
#ifdef FINISH_THIS
#else /* FINISH_THIS */
if(sid==H5P_SCALAR)
ret_value=1;
#endif /* FINISH_THIS */
#ifdef LATER
done:
#endif /* LATER */
if(ret_value == UFAIL)
{ /* Error condition cleanup */
} /* end if */
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5Pnelem() */
/*--------------------------------------------------------------------------
NAME
H5P_release
PURPOSE
Release access to an HDF5 dimensionality object.
USAGE
herr_t H5P_release(oid)
hatom_t oid; IN: Object to release access to
RETURNS
SUCCEED/FAIL
DESCRIPTION
This function releases a dimensionality from active use by a user.
--------------------------------------------------------------------------*/
herr_t H5P_release(hatom_t oid)
{
H5P_dim_t *dim; /* dimensionality object to release */
herr_t ret_value = SUCCEED;
FUNC_ENTER(H5Prelease, H5P_init_interface, FAIL);
/* Clear errors and check args and all the boring stuff. */
H5ECLEAR;
/* Chuck the object! :-) */
if((dim=H5Aremove_atom(oid))==NULL)
HGOTO_ERROR(H5E_ATOM, H5E_BADATOM, FAIL);
if(dim->rank>0)
HDfree(dim->dims);
HDfree(dim);
done:
if(ret_value == FAIL)
{ /* Error condition cleanup */
} /* end if */
/* Normal function cleanup */
FUNC_LEAVE(ret_value);
} /* end H5P_release() */
|
