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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* 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://www.hdfgroup.org/licenses. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
/*
* Programmer: Quincey Koziol
* Saturday, September 12, 2015
*
* Purpose: This file contains declarations which define macros for the
* H5T package. Including this header means that the source file
* is part of the H5T package.
*/
#ifndef H5Tmodule_H
#define H5Tmodule_H
/* Define the proper control macros for the generic FUNC_ENTER/LEAVE and error
* reporting macros.
*/
#define H5T_MODULE
#define H5_MY_PKG H5T
#define H5_MY_PKG_ERR H5E_DATATYPE
/**\defgroup H5T H5T
*
* Use the functions in this module to manage HDF5 datatypes.
*
* HDF5 datatypes describe the element type of HDF5 datasets and attributes.
* There's a large set of predefined datatypes, but users may find it useful
* to define new datatypes through a process called \Emph{derivation}.
*
* The element type is automatically persisted as part of the HDF5 metadata of
* attributes and datasets. Additionally, datatype definitions can be persisted
* to HDF5 files and linked to groups as HDF5 datatype objects or so-called
* \Emph{committed datatypes}.
*
* <table>
* <tr><th>Create</th><th>Read</th></tr>
* <tr valign="top">
* <td>
* \snippet{lineno} H5T_examples.c create
* </td>
* <td>
* \snippet{lineno} H5T_examples.c read
* </td>
* <tr><th>Update</th><th>Delete</th></tr>
* <tr valign="top">
* <td>
* \snippet{lineno} H5T_examples.c update
* </td>
* <td>
* \snippet{lineno} H5T_examples.c delete
* </td>
* </tr>
* </table>
*
* \defgroup ARRAY Array Datatypes
* \ingroup H5T
* \defgroup ATOM Atomic Datatypes
* \ingroup H5T
* \defgroup COMPOUND Compound Datatypes
* \ingroup H5T
* \defgroup CONV Conversion Function
* \ingroup H5T
* \defgroup ENUM Enumeration Datatypes
* \ingroup H5T
* \defgroup OPAQUE Opaque Datatypes
* \ingroup H5T
* \defgroup VLEN Variable-length Sequence Datatypes
* \ingroup H5T
*
* \defgroup PDT Predefined Datatypes
* \ingroup H5T
* \details What is a predefined HDF5 datatype?
* \todo Fill in the blanks!
*
* \defgroup PDTCPU By CPU
* \ingroup PDT
* \details CPU-specific datatypes
* \defgroup PDTALPHA DEC Alpha
* \ingroup PDTCPU
* \defgroup PDTX86 AMD & INTEL
* \ingroup PDTCPU
* \defgroup PDTMIPS SGI MIPS
* \ingroup PDTCPU
*
* \defgroup PDTIEEE IEEE
* \ingroup PDT
* \details The IEEE floating point types in big- and little-endian byte orders.
*
* \defgroup PDTSTD Standard Datatypes
* \ingroup PDT
* \details These are "standard" types. For instance, signed (2's complement)
* and unsigned integers of various sizes in big- and little-endian
* byte orders.
*
* \defgroup PDTUNIX UNIX-specific Datatypes
* \ingroup PDT
* \details Types which are particular to Unix.
* \todo Fill in the blanks!
*
* \defgroup PDTNAT Native Datatypes
* \ingroup PDT
* \details These are the datatypes detected during library \Emph{compilation}
* by \c H5detect(). Their names differ from other HDF5 datatype names
* as follows:
* \li Instead of a class name, precision and byte order as the last
* component, they have a C-like type name.
* \li If the type begins with \c U then it is the unsigned version of
* the integer type; other integer types are signed.
* \li The datatype \c LLONG corresponds C's \Code{long long} and
* \c LDOUBLE is \Code{long double}. These types might be the same
* as \c LONG and \c DOUBLE, respectively.
* \defgroup PDTC9x C9x Integer Datatypes
* \ingroup PDTNAT
* \details C9x integer types
* \todo Fill in the blanks!
*
* \defgroup PDTS Strings
* \ingroup PDT
*
*/
#endif /* H5Tmodule_H */
|
