AddUserData: Stores (asynchronous) user supplied data.

View source: R/RcppExports.R

AddUserDataR Documentation

Stores (asynchronous) user supplied data.

Description

AddUserData stores user supplied data asynchronously to the TOF data acquistion into the current data file. Creates datasets "Data" and "Info" at Location.

Usage

AddUserData(
  Location,
  NbrElements,
  Data,
  ElementDescription = NULL,
  CompressionLevel = 0L
)

Arguments

Location

Location of group in HDF5 file where the datasets are created.

NbrElements

Number of elements to store (per call to this function), maximum is 1048575.

Data

Vector of length NbrElements containing the data to be stored in dataset "Data".

ElementDescription

Vector of length NbrElements containing the text description of elements. If ElementDescription is NULL the dataset "Info" is not created.

CompressionLevel

ZLIB compression level (0-9) for dataset creation. If the dataset at Location already exists this parameter has no effect.

See Also

Other Data storage functions: AddAttributeDouble(), AddAttributeInt(), AddAttributeString(), AddLogEntry(), AddUserDataMultiRow(), GetRegUserDataDesc(), GetRegUserDataSources(), KeepFileOpen(), QueryRegUserDataSize(), ReadRegUserData(), RegisterUserDataBuf(), RegisterUserDataNoStore(), RegisterUserDataWrite(), UnregisterUserData(), UpdateUserData()


pasturm/TofDaqR documentation built on March 29, 2024, 12:10 a.m.