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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*****************************************************************************
FILE
ttypes.cpp - HDF5 C++ testing the general datatype functionality
***************************************************************************/
#ifdef OLD_HEADER_FILENAME
#include <iostream.h>
#else
#include <iostream>
#endif
#include <string>
#ifndef H5_NO_STD
using std::cerr;
using std::endl;
#endif // H5_NO_STD
#include "H5Cpp.h" // C++ API header file
using namespace H5;
#include "h5cpputil.h" // C++ utilility header file
/*
* Offset from alinged memory returned by malloc(). This can be used to test
* that type conversions handle non-aligned buffers correctly.
*/
#define ALIGNMENT 1
/*
* Define if you want to test alignment code on a machine that doesn't
* normally require alignment. When set, all native datatypes must be aligned
* on a byte boundary equal to the data size.
*/
#if 0
#define TEST_ALIGNMENT
/* Alignment test stuff */
#ifdef TEST_ALIGNMENT
#define H5T_PACKAGE
#include "H5Tpkg.h"
#endif
#define SET_ALIGNMENT(TYPE,VAL) \
H5T_NATIVE_##TYPE##_ALIGN_g=MAX(H5T_NATIVE_##TYPE##_ALIGN_g, VAL)
#endif
const char *FILENAME[] = {
"dtypes1.h5",
"dtypes2.h5",
"dtypes3.h5",
NULL
};
/*
* Count up or down depending on whether the machine is big endian or little
* endian. If local variable `endian' is H5T_ORDER_BE then the result will
* be I, otherwise the result will be Z-(I+1).
*/
#define ENDIAN(Z,I) (H5T_ORDER_BE==endian?(I):(Z)-((I)+1))
typedef enum flt_t {
FLT_FLOAT, FLT_DOUBLE, FLT_LDOUBLE, FLT_OTHER
} flt_t;
typedef enum int_t {
INT_CHAR, INT_UCHAR, INT_SHORT, INT_USHORT, INT_INT, INT_UINT,
INT_LONG, INT_ULONG, INT_LLONG, INT_ULLONG, INT_OTHER
} int_t;
/*-------------------------------------------------------------------------
* Function: test_classes
*
* Purpose: Test type classes
*
* Return: None.
*
* Programmer: Binh-Minh Ribler (using C version)
* January, 2007
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static void test_classes()
{
SUBTEST("PredType::getClass()");
try {
// maybe later, int curr_nerrors = GetTestNumErrs();
// PredType::NATIVE_INT should be in H5T_INTEGER class
H5T_class_t tcls = PredType::NATIVE_INT.getClass();
if (H5T_INTEGER!=tcls) {
puts(" Invalid type class for H5T_NATIVE_INT");
}
// PredType::NATIVE_DOUBLE should be in H5T_FLOAT class
tcls = PredType::NATIVE_DOUBLE.getClass();
if (H5T_FLOAT!=tcls) {
verify_val(tcls, H5T_FLOAT, "test_class: invalid type class for NATIVE_DOUBLE -", __LINE__, __FILE__);
}
PASSED();
} // end of try block
catch (Exception& E)
{
issue_fail_msg("test_classes", __LINE__, __FILE__, E.getCDetailMsg());
}
}
/*-------------------------------------------------------------------------
* Function: test_copy
*
* Purpose: Test datatype copy functionality
*
* Return: Success: 0
*
* Failure: number of errors
*
* Programmer: Binh-Minh Ribler (using C version)
* January, 2007
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
static void test_copy()
{
SUBTEST("DataType::copy() and DataType::operator=");
try {
// Test copying from a predefined datatype using DataType::operator=
DataType assigned_type;
assigned_type = PredType::NATIVE_SHORT;
// Test copying a predefined type using DataType::copy
DataType copied_type;
copied_type.copy (PredType::STD_B8LE);
// Test copying a user-defined type using DataType::operator=
DataType assigned_usertype;
assigned_usertype = copied_type;
// Test copying from a user-defined datatype using DataType::copy
DataType copied_usertype;
copied_usertype.copy(copied_type);
// Test copying a user-defined int type using DataType::operator=
IntType orig_int(PredType::STD_B8LE);
DataType generic_type;
generic_type = orig_int;
// Test copying an integer predefined type
IntType new_int_type(PredType::STD_B8LE);
// Test copying an int predefined type using DataType::operator=
IntType another_int_type;
another_int_type = new_int_type;
PASSED();
}
catch (Exception& E)
{
issue_fail_msg("test_copy", __LINE__, __FILE__, E.getCDetailMsg());
}
}
/*-------------------------------------------------------------------------
* Function: test_query
*
* Purpose: Tests query functions of compound and enumeration types.
*
* Return: Success: 0
*
* Failure: number of errors
*
* Programmer: Binh-Minh Ribler (use C version)
* January, 2007
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
const H5std_string CompT_NAME("Compound_type");
const H5std_string EnumT_NAME("Enum_type");
static void test_query()
{
typedef struct {
int a;
float b;
long c;
double d;
} src_typ_t;
short enum_val;
// Output message about test being performed
SUBTEST("Query functions of compound and enumeration types");
try
{
// Create File
H5File file(FILENAME[2], H5F_ACC_TRUNC);
// Create a compound datatype
CompType tid1(sizeof(src_typ_t));
tid1.insertMember("a", HOFFSET(src_typ_t, a), PredType::NATIVE_INT);
tid1.insertMember("b", HOFFSET(src_typ_t, b), PredType::NATIVE_FLOAT);
tid1.insertMember("c", HOFFSET(src_typ_t, c), PredType::NATIVE_LONG);
tid1.insertMember("d", HOFFSET(src_typ_t, d), PredType::NATIVE_DOUBLE);
// Create a enumerate datatype
EnumType tid2(sizeof(short));
tid2.insert("RED", (enum_val=0,&enum_val));
tid2.insert("GREEN", (enum_val=1,&enum_val));
tid2.insert("BLUE", (enum_val=2,&enum_val));
tid2.insert("ORANGE", (enum_val=3,&enum_val));
tid2.insert("YELLOW", (enum_val=4,&enum_val));
// Query member number and member index by name, for compound type
int nmembs = tid1.getNmembers();
verify_val(nmembs, 4, "CompType::getNmembers()", __LINE__, __FILE__);
int index = tid1.getMemberIndex("c");
verify_val(index, 2, "CompType::getMemberIndex()", __LINE__, __FILE__);
// Query member number and member index by name, for enumeration type.
nmembs = tid2.getNmembers();
verify_val(nmembs, 5, "EnumType::getNmembers()", __LINE__, __FILE__);
index = tid2.getMemberIndex("ORANGE");
verify_val(index, 3, "EnumType::getMemberIndex()", __LINE__, __FILE__);
// Commit compound datatype, and test getting the datatype creation
// prop list, then close it
tid1.commit(file, CompT_NAME);
PropList tcpl = tid1.getCreatePlist();
if (!IdComponent::isValid(tcpl.getId()))
{
// Throw an invalid action exception
throw InvalidActionException("IdComponent::isValid", "Datatype creation property list is not valid");
}
tcpl.close();
tid1.close();
// Commit enumeration datatype, and test getting the datatype creation
// prop list, then close it
tid2.commit(file, EnumT_NAME);
tcpl = tid2.getCreatePlist();
if (!IdComponent::isValid(tcpl.getId()))
{
// Throw an invalid action exception
throw InvalidActionException("IdComponent::isValid", "Datatype creation property list is not valid");
}
tcpl.close();
tid2.close();
// Open the datatypes for query
tid1 = file.openCompType(CompT_NAME);
tid2 = file.openEnumType(EnumT_NAME);
// Query member number and member index by name, for compound type
nmembs = tid1.getNmembers();
verify_val(nmembs, 4, "CompType::getNmembers()", __LINE__, __FILE__);
index = tid1.getMemberIndex("c");
verify_val(index, 2, "CompType::getMemberIndex()", __LINE__, __FILE__);
// Query member number and member index by name, for enumeration type
nmembs = tid2.getNmembers();
verify_val(nmembs, 5, "EnumType::getNmembers()", __LINE__, __FILE__);
index = tid2.getMemberIndex("ORANGE");
verify_val(index, 3, "EnumType::getMemberIndex()", __LINE__, __FILE__);
// Close datatypes and file
tid1.close();
tid2.close();
file.close();
// Try truncating the file to make sure reference counting is good.
// If any references to ids of tid1 and tid2 are left unterminated,
// the truncating will fail, because the file will not be closed in
// the file.close() above.
H5File file1(FILENAME[2], H5F_ACC_TRUNC);
PASSED();
} // end of try block
catch (Exception& E)
{
issue_fail_msg("test_query", __LINE__, __FILE__, E.getCDetailMsg());
}
} // test_query
/*-------------------------------------------------------------------------
* Function: test_transient
*
* Purpose: Tests transient datatypes.
*
* Return: Success: 0
*
* Failure: number of errors
*
* Programmer: Binh-Minh Ribler (use C version)
* January, 2007
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
const char* filename1 = "dtypes1.h5";
static void test_transient ()
{
static hsize_t ds_size[2] = {10, 20};
SUBTEST("Transient datatypes");
try {
// Create the file and the dataspace.
H5File file(filename1, H5F_ACC_TRUNC);
DataSpace space(2, ds_size, ds_size);
// Copying a predefined type results in a modifiable copy
IntType type(PredType::NATIVE_INT);
type.setPrecision(256);
// It should not be possible to create an attribute for a transient type
try {
Attribute attr(type.createAttribute("attr1", PredType::NATIVE_INT, space));
// Should FAIL but didn't, so throw an invalid action exception
throw InvalidActionException("H5Object::createAttribute", "Attempted to commit a predefined datatype.");
} catch (AttributeIException& err) {} // do nothing, failure expected
// Create a dataset from a transient datatype
// type.close(); - put trace in H5Tclose to make sure it's closed
type.copy(PredType::NATIVE_INT);
DataSet dset(file.createDataSet("dset1", type, space));
// The type returned from a dataset should not be modifiable
IntType itype(dset);
try {
itype.setPrecision(256);
// Should FAIL but didn't, so throw an invalid action exception
throw InvalidActionException("PredType::setPrecision", "Dataset datatypes should not be modifiable!");
} catch (DataTypeIException& err) {}
itype.close();
// Get a copy of the dataset's datatype by applying DataType::copy()
// to the dataset. The resulted datatype should be modifiable.
itype.copy(dset);
itype.setPrecision(256);
itype.close();
// Close the dataset and reopen it, testing that its type is still
// read-only. (Note that a copy of it is modifiable.)
dset.close();
dset = file.openDataSet("dset1");
// Close objects and file.
dset.close();
file.close();
type.close();
space.close();
PASSED();
} // end of try block
catch (Exception& E)
{
issue_fail_msg("test_transient", __LINE__, __FILE__, E.getCDetailMsg());
}
} // test_transient
/*-------------------------------------------------------------------------
* Function: test_named
*
* Purpose: Tests named datatypes.
*
* Return: Success: 0
*
* Failure: number of errors
*
* Programmer: Binh-Minh Ribler (use C version)
* January, 2007
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
const H5std_string filename2("dtypes2.h5");
static void test_named ()
{
static hsize_t ds_size[2] = {10, 20};
hsize_t i;
unsigned attr_data[10][20];
DataType *ds_type = NULL;
SUBTEST("Named datatypes");
try {
// Create the file.
H5File file(filename2, H5F_ACC_TRUNC);
// Create a simple dataspace.
DataSpace space(2, ds_size, ds_size);
// Predefined types cannot be committed.
try {
PredType nativeint(PredType::NATIVE_INT);
nativeint.commit(file, "test_named_1 (should not exist)");
// Should FAIL but didn't, so throw an invalid action exception
throw InvalidActionException("PredType::commit", "Attempted to commit a predefined datatype.");
} catch (DataTypeIException& err) {}
// Copy a predefined datatype and commit the copy.
IntType itype(PredType::NATIVE_INT);
itype.commit(file, "native-int");
// Test commit passing in const H5File& for prototype with const
try
{
// Create random char type
IntType atype(PredType::NATIVE_UCHAR);
// Creating group, declared as const
const Group const_grp = file.createGroup("GR as loc");
// Commit type passing in const group; compilation would fail if
// no matching prototype
atype.commit(const_grp, "random uchar");
} // end of try block
catch (Exception& E)
{
issue_fail_msg("test_named", __LINE__, __FILE__, "Commit at const group");
}
// Check that it is committed.
if (itype.committed() == false)
cerr << "IntType::committed() returned false" << endl;
// We should not be able to modify a type after it has been committed.
try {
itype.setPrecision(256); // attempt an invalid action...
// Should FAIL but didn't, so throw an invalid action exception
throw InvalidActionException("IntType::setPrecision", "Attempted to modify a committed datatype.");
} catch (DataTypeIException& err) {}
// We should not be able to re-commit a committed type
try {
itype.commit(file, "test_named_2 (should not exist)");
// Should FAIL but didn't, so throw an invalid action exception
throw InvalidActionException("IntType::commit", "Attempted to re-commit a committed datatype.");
} catch (DataTypeIException& err) {} // do nothing, failure expected
// It should be possible to define an attribute for the named type
Attribute attr1 = itype.createAttribute("attr1", PredType::NATIVE_UCHAR, space);
for (i=0; i<ds_size[0]*ds_size[1]; i++)
attr_data[0][i] = (int)i;/*tricky*/
attr1.write(PredType::NATIVE_UINT, attr_data);
attr1.close();
// Copying a committed type should result in a transient type which is
// not locked.
IntType trans_type;
trans_type.copy(itype);
bool iscommitted = trans_type.committed();
verify_val(iscommitted, 0, "DataType::committed() - Copying a named type should result in a transient type!", __LINE__, __FILE__);
trans_type.setPrecision(256);
trans_type.close();
// Close the committed type and reopen it. It should be a named type.
itype.close();
itype = file.openIntType("native-int");
iscommitted = itype.committed();
if (!iscommitted)
throw InvalidActionException("IntType::committed()", "Opened named types should be named types!");
// Create a dataset that uses the named type, then get the dataset's
// datatype and make sure it's a named type.
DataSet dset = file.createDataSet("dset1", itype, space);
ds_type = new DataType(dset.getDataType());
iscommitted = ds_type->committed();
if (!iscommitted)
throw InvalidActionException("IntType::committed()", "Dataset type should be named type!");
dset.close();
ds_type->close();
delete ds_type;
// Reopen the dataset and its type, then make sure the type is
// a named type.
dset = file.openDataSet("dset1");
ds_type = new DataType(dset.getDataType());
iscommitted = ds_type->committed();
if (!iscommitted)
throw InvalidActionException("IntType::committed()", "Dataset type should be named type!");
// Close the dataset and create another with the type returned from
// the first dataset.
dset.close();
dset = file.createDataSet("dset2", *ds_type, space);
ds_type->close();
dset.close();
delete ds_type;
// Reopen the second dataset and make sure the type is shared
dset = file.openDataSet("dset2");
ds_type = new DataType(dset.getDataType());
iscommitted = ds_type->committed();
if (!iscommitted)
throw InvalidActionException("DataType::iscommitted()", "Dataset type should be named type!");
ds_type->close();
// Get the dataset datatype by applying DataType::copy() to the
// dataset. The resulted datatype should be modifiable.
IntType copied_type;
copied_type.copy(dset);
copied_type.setPrecision(256);
copied_type.close();
// Clean up
dset.close();
itype.close();
space.close();
file.close();
PASSED();
} // end of try block
catch (Exception& E)
{
issue_fail_msg("test_named", __LINE__, __FILE__, E.getCDetailMsg());
}
if(ds_type)
delete ds_type;
} // test_named
/****************************************************************
**
** test_types(): Main datatypes testing routine.
**
****************************************************************/
extern "C"
void test_types()
{
// Output message about test being performed
MESSAGE(5, ("Testing Generic Data Types\n"));
// Test basic datatypes
test_classes();
test_copy();
test_query();
test_transient();
test_named();
} // test_types()
/*-------------------------------------------------------------------------
* Function: cleanup_types
*
* Purpose: Cleanup temporary test files
*
* Return: none
*
* Programmer: Quincey Koziol
* September 10, 1999
*
* Modifications:
*
*-------------------------------------------------------------------------
*/
extern "C"
void cleanup_types()
{
for (int i = 0; i < 3; i++)
HDremove(FILENAME[i]);
} // cleanup_types
|