gmx::H5mdDataSetBuilder< ValueType > Class Template Reference

#include <gromacs/fileio/h5md/h5md_datasetbuilder.h>

Inheritance diagram for gmx::H5mdDataSetBuilder< ValueType >:

Description

template<typename ValueType>
class gmx::H5mdDataSetBuilder< ValueType >

Builder class for H5md data sets.

This class facilitates setting various options such as dimensions for a data set. When constructing the data set with a call to build() these options are validated and the data set created with a type derived from the templated type.

For non-primitive data types such as BasicVector<float> the data set is created with the base primitive as its type and the data type size is added as the innermost dimension to the data storage: This keeps the data layout in row-major order. For example, the storage layout for a data set of BasicVector<float> with dimensions [20][50] is float[20][50][3].

Template Parameters

ValueType

Native type to create data set for.

Public Member Functions
	H5mdDataSetBuilder (const hid_t container, const std::string &name)
	Construct a builder for a data set with name in container.
	GMX_DISALLOW_COPY_MOVE_AND_ASSIGN (H5mdDataSetBuilder)
H5mdDataSetBuilder &	withCompression (const H5mdCompression compression)
	Set compression for data set.
H5mdDataSetBuilder &	withDimension (ArrayRef< const hsize_t > dims)
	Set data set dimensions (required).
H5mdDataSetBuilder &	withDimension (std::initializer_list< hsize_t > dims)
	Set data set dimensions (required). More...
H5mdDataSetBuilder &	withMaxDimension (ArrayRef< const hsize_t > maxDims)
	Set maximum dimension for data set (default: same as data set dimension).
H5mdDataSetBuilder &	withMaxDimension (std::initializer_list< hsize_t > maxDims)
	Set maximum dimension for data set (default: same as data set dimension). More...
H5mdDataSetBuilder &	withChunkDimension (ArrayRef< const hsize_t > chunkDims)
	Set chunk dimension for data set (default: same as data set dimension).
H5mdDataSetBuilder &	withChunkDimension (std::initializer_list< hsize_t > chunkDims)
	Set chunk dimension for data set (default: same as data set dimension). More...
H5mdDataSetBuilder &	withMaxStringLength (const int maxLength)
	Set the data set to use a fixed size string with maximum length maxLength.
H5mdDataSetBuilder &	withVariableStringLength ()
	Set the data set to use variable length strings.
H5mdDataSetBuilder &	withUnit (std::string_view unit)
	Set unit attribute for data set values.
H5mdDataSetBase< ValueType >	build ()
	Finalize all set options, then build and return the data set.

Member Function Documentation

template<typename ValueType >

H5mdDataSetBuilder& gmx::H5mdDataSetBuilder< ValueType >::withChunkDimension ( std::initializer_list< hsize_t >  chunkDims )

inline

Set chunk dimension for data set (default: same as data set dimension).

template<typename ValueType >

H5mdDataSetBuilder& gmx::H5mdDataSetBuilder< ValueType >::withDimension ( std::initializer_list< hsize_t >  dims )

inline

Set data set dimensions (required).

template<typename ValueType >

H5mdDataSetBuilder& gmx::H5mdDataSetBuilder< ValueType >::withMaxDimension ( std::initializer_list< hsize_t >  maxDims )

inline

Set maximum dimension for data set (default: same as data set dimension).

---

The documentation for this class was generated from the following files:

• src/gromacs/fileio/h5md/h5md_datasetbase.h
• src/gromacs/fileio/h5md/h5md_datasetbuilder.h