File: H5T_VLEN-class.Rd

package info (click to toggle)
r-cran-hdf5r 1.3.8%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 10,192 kB
  • sloc: ansic: 76,883; sh: 82; python: 32; makefile: 13
file content (47 lines) | stat: -rw-r--r-- 1,125 bytes parent folder | download | duplicates (2)
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/R6Classes_H5T.R
\docType{class}
\name{H5T_VLEN-class}
\alias{H5T_VLEN-class}
\alias{H5T_VLEN}
\title{Class for HDF5 variable-length datatypes.}
\value{
Object of class \code{\link[=H5T_VLEN]{H5T_VLEN}}.
}
\description{
Inherits from class \code{\link[=H5T]{H5T}}. This can make any datatype a variable length datatype.
This would mostly be intended for storing ragged arrays.
}
\section{Methods}{

\describe{
\item{\code{new(dtype_base, id = NULL)}}{

Create a variable length datatype

\strong{Parameters}
\describe{
\item{dtype_base}{The basis-type of the variable length datatype}
\item{id}{Internal use only}
}}

\item{\code{get_super()}}{

This function implements the HDF5-API function H5Tget_super.
Please see the documentation at \url{https://portal.hdfgroup.org/display/HDF5/H5T_GET_SUPER} for details.}

\item{\code{describe()}}{

Print a detailed description of the datatype; this is experimental}
}}

\examples{
vlen_int <- H5T_VLEN$new(h5types$H5T_NATIVE_INT)
vlen_int
}
\seealso{
\code{\link[=H5T]{H5T}}
}
\author{
Holger Hoefling
}