summaryrefslogtreecommitdiffstats
path: root/hl/src/H5DS.h
blob: b179a195dd08a74f66c1911e98801732619b1c82 (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
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92

/****************************************************************************
 * NCSA HDF                                                                 *
 * Scientific Data Technologies                                             *
 * 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.                                                        *
 *                                                                          *
 ****************************************************************************/


#ifndef _H5DS_H
#define _H5DS_H

#include <hdf5.h>

#ifndef TRUE
#define TRUE 1
#endif

#define DIMENSION_SCALE_CLASS "DIMENSION_SCALE"
#define DIMENSION_LIST        "DIMENSION_LIST"
#define REFERENCE_LIST        "REFERENCE_LIST"
#define DIMENSION_LABELS      "DIMENSION_LABELS"

typedef herr_t (*H5DS_iterate_t)(hid_t dset, unsigned dim, hid_t scale, void *visitor_data); 


/* attribute type of a DS dataset */
typedef struct ds_list_t {
 hobj_ref_t ref;     /* object reference  */
 int        dim_idx; /* dimension index of the dataset */
} ds_list_t;


#ifdef __cplusplus
extern "C" {
#endif

herr_t H5DSattach_scale(hid_t did,
                        hid_t dsid,
                        unsigned int idx);

herr_t H5DSdetach_scale(hid_t did,
                        hid_t dsid,
                        unsigned int idx);

herr_t H5DSset_scale(hid_t did, 
                     char *dimname);

herr_t H5DSget_nscales(hid_t did,
                       unsigned int dim,
                       int *nscales);

herr_t H5DSset_label(hid_t did, 
                     char *label,
                     unsigned int idx);

herr_t H5DSget_label(hid_t did, 
                     char *label,
                     unsigned int idx);

herr_t H5DSget_scale_name(hid_t did, 
                          char *buf);

herr_t H5DSis_scale(hid_t did);

herr_t H5DSiterate_scales(hid_t did, 
                          unsigned int dim, 
                          int *idx, 
                          H5DS_iterate_t visitor, 
                          void *visitor_data);


/*-------------------------------------------------------------------------
 * private functions
 *-------------------------------------------------------------------------
 */
htri_t H5DS_is_attached(hid_t loc_id, 
                        const char *dname,
                        const char *dsname,
                        unsigned int idx);


#ifdef __cplusplus
}
#endif

#endif