gmx::H5mdFrameDataSetBuilder< ValueType > Class Template Reference

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

Inheritance diagram for gmx::H5mdFrameDataSetBuilder< ValueType >:

Collaboration diagram for gmx::H5mdFrameDataSetBuilder< ValueType >:

Description

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

Builder class for framed H5md data sets.

This constructs data sets with the outermost dimension being for frames. The dimension for each frame can be specified using withFrameDimension() and the number of frames in the created data set controlled with withNumFrames() and withMaxNumFrames().

By default data sets are created with 0 initial frames and an unlimited maximum number of frames. The default frame dimensions are empty (identical to calling withFrameDimension({})), which means that each frame contains a scalar value.

See also the documentation for H5mdDataSetBuilder.

Template Parameters

ValueType

Native type to create data set for.

Public Types
using	Base = H5mdDataSetBuilder< ValueType >

Public Member Functions
H5mdFrameDataSetBuilder &	withCompression (const H5mdCompression compression)
	Set compression for data set. More...
H5mdFrameDataSetBuilder &	withFrameDimension (ArrayRef< const hsize_t > dims)
	Set dimension for a single frame in the data set.
H5mdFrameDataSetBuilder &	withFrameDimension (std::initializer_list< hsize_t > dims)
	Set dimension for a single frame in the data set. More...
H5mdFrameDataSetBuilder &	withNumFrames (const hsize_t numFrames)
	Set number of frames to create the data set with (default is 0).
H5mdFrameDataSetBuilder &	withMaxNumFrames (const hsize_t maxNumFrames)
	Set maximum number of frames for the created data set (default is unlimited).
H5mdFrameDataSetBuilder &	withMaxStringLength (const int maxLength)
	Set the frame data set to use a fixed size string with maximum length maxLength.
H5mdFrameDataSetBuilder &	withVariableStringLength ()
	Set the frame data set to use variable length strings.
H5mdFrameDataSetBuilder &	withUnit (std::string_view unit)
	Set unit attribute for data set values. More...
H5mdDataSetBase< ValueType >	build ()
	Create the data set, then build and return it.

Member Function Documentation

template<typename ValueType >

H5mdFrameDataSetBuilder& gmx::H5mdFrameDataSetBuilder< ValueType >::withCompression ( const H5mdCompression  compression )

inline

Set compression for data set.

template<typename ValueType >

H5mdFrameDataSetBuilder& gmx::H5mdFrameDataSetBuilder< ValueType >::withFrameDimension ( std::initializer_list< hsize_t >  dims )

inline

Set dimension for a single frame in the data set.

template<typename ValueType >

H5mdFrameDataSetBuilder& gmx::H5mdFrameDataSetBuilder< ValueType >::withUnit ( std::string_view  unit )

inline

Set unit attribute for data set values.

---

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

• src/gromacs/fileio/h5md/h5md_framedatasetbuilder.h