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
|
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* 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
* H5I package. Including this header means that the source file
* is part of the H5I package.
*/
#ifndef H5Imodule_H
#define H5Imodule_H
/* Define the proper control macros for the generic FUNC_ENTER/LEAVE and error
* reporting macros.
*/
#define H5I_MODULE
#define H5_MY_PKG H5I
#define H5_MY_PKG_ERR H5E_ID
/** \page H5I_UG The HDF5 Identifiers
* @todo Under Construction
*/
/**
* \defgroup H5I Identifiers (H5I)
*
* Use the functions in this module to manage identifiers defined by the HDF5
* library. See \ref H5IUD for user-defined identifiers and identifier
* types.
*
* HDF5 identifiers are usually created as a side-effect of creating HDF5
* entities such as groups, datasets, attributes, or property lists.
*
* Identifiers defined by the HDF5 library can be used to retrieve information
* such as path names and reference counts, and their validity can be checked.
*
* Identifiers can be updated by manipulating their reference counts.
*
* Unused identifiers should be reclaimed by closing the associated item, e.g.,
* HDF5 object, or decrementing the reference count to 0.
*
* \note Identifiers (of type \ref hid_t) are run-time auxiliaries and
* not persisted in the file.
*
* <table>
* <tr><th>Create</th><th>Read</th></tr>
* <tr valign="top">
* <td>
* \snippet{lineno} H5I_examples.c create
* </td>
* <td>
* \snippet{lineno} H5I_examples.c read
* </td>
* <tr><th>Update</th><th>Delete</th></tr>
* <tr valign="top">
* <td>
* \snippet{lineno} H5I_examples.c update
* </td>
* <td>
* \snippet{lineno} H5I_examples.c delete
* </td>
* </tr>
* </table>
*
* \defgroup H5IUD User-defined ID Types
* \ingroup H5I
*
* The \ref H5I module contains functions to define new identifier types.
* For convenience, handles of type \ref hid_t can then be associated with the
* new identifier types and user objects.
*
* New identifier types can be created by registering a new identifier type
* with the HDF5 library. Once a new identifier type has bee registered,
* it can be used to generate identifiers for user objects.
*
* User-defined identifier types can be searched and iterated.
*
* Like library-defined identifiers, user-defined identifiers \Emph{and}
* identifier types are reference counted, and the reference counts can be
* manipulated accordingly.
*
* User-defined identifiers no longer in use should be deleted or reclaimed,
* and identifier types should be destroyed if they are no longer required.
*
* <table>
* <tr><th>Create</th><th>Read</th></tr>
* <tr valign="top">
* <td>
* \snippet{lineno} H5I_examples.c create_ud
* </td>
* <td>
* \snippet{lineno} H5I_examples.c read_ud
* </td>
* <tr><th>Update</th><th>Delete</th></tr>
* <tr valign="top">
* <td>
* \snippet{lineno} H5I_examples.c update_ud
* </td>
* <td>
* \snippet{lineno} H5I_examples.c delete_ud
* </td>
* </tr>
* </table>
*
*/
#endif /* H5Imodule_H */
|
