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
|
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/R6Classes_H5T.R
\docType{class}
\name{H5T-class}
\alias{H5T-class}
\alias{H5T}
\title{Class for HDF5 datatypes.}
\value{
Object of class \code{\link{H5T}}.
}
\description{
This is the base class for all datatypes, but most have a specialised class.
This class represents an HDF5 datatype. It inherits all functions of the
\code{\link{H5RefClass}}. It is also the base class for many other classes well, specifically
\describe{
\item{Integer}{\code{\link{H5T_INTEGER}}}
\item{Bitfield}{\code{\link{H5T_BITFIELD}} (currently identical to the integer class)}
\item{Float}{\code{\link{H5T_FLOAT}}}
\item{Enum}{\code{\link{H5T_ENUM}}}
\item{Compound}{\code{\link{H5T_COMPOUND}}}
\item{String}{\code{\link{H5T_STRING}}}
\item{Complex}{\code{\link{H5T_COMPLEX}}}
\item{Array}{\code{\link{H5T_ARRAY}}}
\item{Variable Length}{\code{\link{H5T_VLEN}}}
}
}
\section{Methods}{
\describe{
\item{\code{new(id)}}{
Internal use only}
\item{\code{get_class()}}{
This function implements the HDF5-API function H5Tget_class.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_CLASS} for details.}
\item{\code{get_size(...)}}{
This function implements the HDF5-API function H5Tget_size.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_SIZE} for details.
\strong{Parameters}
\describe{
\item{...}{ignored}
}}
\item{\code{set_size(size)}}{
This function implements the HDF5-API function H5Tset_size.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_SET_SIZE} for details.}
\item{\code{set_precision(precision)}}{
This function implements the HDF5-API function H5Tset_precision.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_SET_PRECISION} for details.}
\item{\code{get_precision()}}{
This function implements the HDF5-API function H5Tget_precision.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_PRECISION} for details.}
\item{\code{set_order(order)}}{
This function implements the HDF5-API function H5Tset_order.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_SET_ORDER} for details.}
\item{\code{get_order()}}{
This function implements the HDF5-API function H5Tget_order.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_ORDER} for details.}
\item{\code{set_offset(offset)}}{
This function implements the HDF5-API function H5Tset_offset.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_SET_OFFSET} for details.}
\item{\code{get_offset()}}{
This function implements the HDF5-API function H5Tget_offset.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_OFFSET} for details.}
\item{\code{set_pad(pad)}}{
This function implements the HDF5-API function H5Tset_pad.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_SET_PAD} for details.}
\item{\code{get_pad()}}{
This function implements the HDF5-API function H5Tget_pad.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_PAD} for details.}
\item{\code{copy()}}{
This function implements the HDF5-API function H5Tcopy.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_COPY} for details.}
\item{\code{is_committed()}}{
This function implements the HDF5-API function H5Tcommitted.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_COMMITTED} for details.}
\item{\code{equal(dtype)}}{
This function implements the HDF5-API function H5Tequal.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_EQUAL} for details.}
\item{\code{is_vlen()}}{
This function detects if the underlying type is H5T_VLEN or a variable length string. This is used to know if
after reading a dataset, memory has to be freed}
\item{\code{detect_class(dtype_class)}}{
This function implements the HDF5-API function H5Tdetect_class.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_DETECT_CLASS} for details.}
\item{\code{get_native_type(direction = h5const$H5T_DIR_ASCEND)}}{
This function implements the HDF5-API function H5Tget_native_type.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_NATIVE_TYPE} for details.}
\item{\code{get_create_plist()}}{
This function implements the HDF5-API function H5Tget_create_plist.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_CREATE_PLIST} for details.}
\item{\code{to_text(lang_type = h5const$H5LT_DDL)}}{
This function implements the HDF5-API function H5LTdtype_to_text.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5LT_DTYPE_TO_TEXT} for details.}
\item{\code{print(...)}}{
Prints information for the group
\strong{Parameters}
\describe{
\item{...}{ignored}
}}
\item{\code{obj_info(remove_internal_use_only = TRUE)}}{
This function implements the HDF5-API function H5Oget_info.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5O_GET_INFO} for details.}
\item{\code{get_obj_name()}}{
This function implements the HDF5-API function H5Iget_name.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5I_GET_NAME} for details.}
\item{\code{create_attr(attr_name, robj = NULL, dtype = NULL, space = NULL)}}{
This function implements the HDF5-API function H5Acreate2.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_CREATE2} for details.}
\item{\code{attr_open(attr_name)}}{
This function implements the HDF5-API function H5Aopen.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_OPEN} for details.}
\item{\code{create_attr_by_name(attr_name, obj_name, robj = NULL,
dtype = NULL, space = NULL,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Acreate_by_name.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_CREATE_BY_NAME} for details.}
\item{\code{attr_open_by_name(attr_name, obj_name,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Aopen_by_name.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_OPEN_BY_NAME} for details.}
\item{\code{attr_open_by_idx(n, obj_name, idx_type = h5const$H5_INDEX_NAME,
order = h5const$H5_ITER_NATIVE,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Aopen_by_idx.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_OPEN_BY_IDX} for details.}
\item{\code{attr_exists_by_name(attr_name, obj_name,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Aexists_by_name.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_EXISTS_BY_NAME} for details.}
\item{\code{attr_exists(attr_name)}}{
This function implements the HDF5-API function H5Aexists.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_EXISTS} for details.}
\item{\code{attr_rename_by_name(old_attr_name, new_attr_name, obj_name,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Arename_by_name.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_RENAME_BY_NAME} for details.}
\item{\code{attr_rename(old_attr_name, new_attr_name)}}{
This function implements the HDF5-API function H5Arename.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_RENAME} for details.}
\item{\code{attr_delete(attr_name)}}{
This function implements the HDF5-API function H5Adelete.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_DELETE} for details.}
\item{\code{attr_delete_by_name(attr_name, obj_name,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Adelete_by_name.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_DELETE_BY_NAME} for details.}
\item{\code{attr_delete_by_idx(n, obj_name, idx_type = h5const$H5_INDEX_NAME,
order = h5const$H5_ITER_NATIVE,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Adelete_by_idx.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_DELETE_BY_IDX} for details.}
\item{\code{attr_info_by_name(attr_name, obj_name,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Aget_info_by_name.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_GET_INFO_BY_NAME} for details.}
\item{\code{attr_info_by_idx(n, obj_name, idx_type = h5const$H5_INDEX_NAME,
order = h5const$H5_ITER_NATIVE,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Aget_info_by_idx.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_GET_INFO_BY_IDX} for details.}
\item{\code{attr_name_by_idx(n, obj_name, idx_type = h5const$H5_INDEX_NAME,
order = h5const$H5_ITER_NATIVE,
link_access_pl = h5const$H5P_DEFAULT)}}{
This function implements the HDF5-API function H5Aget_name_by_idx.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5A_GET_NAME_BY_IDX} for details.}
\item{\code{attr_get_number()}}{
This function implements the HDF5-API function H5Aget_num_attrs.
Please see the documentation at \url{https://support.hdfgroup.org/HDF5/doc/RM/RM_H5A.html#Annot-NumAttrs} for details.}
\item{\code{create_reference(name = ".", space = NULL)}}{
This function implements the HDF5-API function H5Rcreate. If \code{space=NULL} then a \code{H5R_OBJECT} reference
is created, otherwise a \code{H5R_DATASET_REGION} reference
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5R_CREATE} for details.}
}}
\examples{
my_int <- h5types$H5T_NATIVE_INT
my_int$to_text()
my_int$get_size()
# Show how to commit a datatype
fname <- tempfile(fileext = ".h5")
file <- H5File$new(fname, mode = "a")
my_int$is_committed()
file$commit("my_int", my_int)
my_int$is_committed()
# can now also add attributes
h5attr(my_int, "test") <- "A string"
h5attributes(my_int)
file$close_all()
file.remove(fname)
}
\author{
Holger Hoefling
}
|
