H5T_STRING-class {hdf5r} | R Documentation |
Class for HDF5 string datatypes.
Description
Inherits from class H5T
.
Value
Object of class H5T_STRING
.
Methods
new(type = c("c", "fortran"), size = 1, id = NULL)
-
Create a string datatype
Parameters
- A
C or fortran type string
- size
Size of the string object. Set to
Inf
for variable size strings- id
internal use only
get_size(variable_as_inf = TRUE)
-
Retrieves the length of the string, setting it to
Inf
it is of variable length. This function implements the HDF5-API function H5Tis_variable_str. Please see the documentation at https://docs.hdfgroup.org/hdf5/v1_10/group___h5_t.html for details. get_cset()
-
This function implements the HDF5-API function H5Tget_cset. Please see the documentation at https://docs.hdfgroup.org/hdf5/v1_10/group___h5_t.html for details.
set_cset(cset = c("unknown", "UTF-8"))
-
This function implements the HDF5-API function H5Tset_cset. Please see the documentation at https://docs.hdfgroup.org/hdf5/v1_10/group___h5_t.html for details.
set_strpad(strpad)
-
This function implements the HDF5-API function H5Tset_strpad. Please see the documentation at https://docs.hdfgroup.org/hdf5/v1_10/group___h5_t.html for details.
get_strpad()
-
This function implements the HDF5-API function H5Tget_strpad. Please see the documentation at https://docs.hdfgroup.org/hdf5/v1_10/group___h5_t.html for details.
describe()
-
Print a detailed description of the datatype; this is experimental
Author(s)
Holger Hoefling
See Also
Examples
# fixed width string
str_flen <- H5T_STRING$new(size=100)
str_flen$is_vlen()
str_flen
# variable length string
str_vlen <- H5T_STRING$new(size=Inf)
str_vlen$is_vlen()
str_vlen