summaryrefslogtreecommitdiffstats
path: root/src/H5Ipublic.h
blob: 2ae564035e62c1fd5a9e9ea4363783c6348b5417 (plain)
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
/****************************************************************************
 * 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.							    *
 *									    *
 ****************************************************************************/

/*
 * This file contains function prototypes for each exported function in
 * the H5I module.
 */
#ifndef _H5Ipublic_H
#define _H5Ipublic_H

/* Public headers needed by this file */
#include <H5public.h>

/*
 * Group values allowed.  Start with `1' instead of `0' because it makes the
 * tracing output look better when hid_t values are large numbers.  Change the
 * GROUP_BITS in H5I.c if the MAXID gets larger than 32 (an assertion will
 * fail otherwise).
 */
typedef enum {
    H5I_BADID		= (-1),	/*invalid Group				    */
    H5I_FILE		= 1,	/*group ID for File objects		    */
    H5I_FILE_CLOSING,		/*files pending close due to open objhdrs   */
    H5I_TEMPLATE_0,		/*group ID for Template objects		    */
    H5I_TEMPLATE_1,	       	/*group ID for Template objects		    */
    H5I_TEMPLATE_2,	        /*group ID for Template objects		    */
    H5I_TEMPLATE_3,	        /*group ID for Template objects		    */
    H5I_TEMPLATE_4,	        /*group ID for Template objects		    */
    H5I_TEMPLATE_5,	        /*group ID for Template objects		    */
    H5I_TEMPLATE_6,	        /*group ID for Template objects		    */
    H5I_TEMPLATE_7,	        /*group ID for Template objects		    */
#ifndef NDEBUG
    H5I_TEMPLATE_MAX,	        /*not really a group ID			    */
#endif
    H5I_GROUP,		        /*group ID for Group objects		    */
    H5I_DATATYPE,	        /*group ID for Datatype objects		    */
    H5I_DATASPACE,	        /*group ID for Dataspace objects	    */
    H5I_DATASET,	        /*group ID for Dataset objects		    */
    H5I_ATTR,		        /*group ID for Attribute objects	    */
    H5I_TEMPBUF,	        /*group ID for Temporary buffer objects	    */
    H5I_RAGGED,		        /*group ID for Ragged array objects	    */
    H5I_REFERENCE,	        /*group ID for Reference objects	    */
    
    H5I_NGROUPS		        /*number of valid groups, MUST BE LAST!	    */
} H5I_type_t;

/* Type of atoms to return to users */
typedef int hid_t;

#ifdef __cplusplus
extern "C" {
#endif

__DLL__ H5I_type_t H5Iget_type(hid_t id);


#ifdef __cplusplus
}
#endif
#endif