gmx::H5mdScalarFrameDataSet< ValueType > Class Template Reference

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

Inheritance diagram for gmx::H5mdScalarFrameDataSet< ValueType >:

Collaboration diagram for gmx::H5mdScalarFrameDataSet< ValueType >:

Description

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

Class which provides an interface for reading and writing scalar frame data to H5mdDataSetBase objects.

Scalar frame data is a 1d array of the templated type, e.g. float[numFrames] or RVec[numFrames]. This class is a specializion of H5mdFrameDataSet for such data sets and provides a simpler I/O interface for reading and writing single values from/into the data sets.

Template Parameters

ValueType

Type of values stored in data set (not limited to base primitives).

Public Member Functions
	H5mdScalarFrameDataSet (H5mdFrameDataSet< ValueType > &&dataSet)
	Constructor to manage a given dataSet. More...
	H5mdScalarFrameDataSet (hid_t container, const char *name)
	Constructor to open an existing data set (called name, in container). More...
void	readFrame (hsize_t frameIndex, ValueType *value)
	Read data from frame at index into value. More...
void	writeNextFrame (const ValueType &value)
	Write data from values into the next frame. More...

Private Types
using	Base = H5mdDataSetBase< ValueType >

Private Member Functions
const DataSetDims &	frameDims () const
	Return the dimensions of a single frame of the templated type in data set. More...
hsize_t	numFrames () const noexcept
	Return the number of frames in the data set. More...
void	readFrame (hsize_t index, ArrayRef< ValueType > values)
	Read data from frame at index into values. More...
void	writeNextFrame (ArrayRef< const ValueType > values)
	Write data from values into the next frame. More...

Constructor & Destructor Documentation

template<typename ValueType>

gmx::H5mdScalarFrameDataSet< ValueType >::H5mdScalarFrameDataSet

(

H5mdFrameDataSet< ValueType > &&

dataSet

)

Constructor to manage a given dataSet.

Exceptions

gmx::FileIOError

if the data set frame dimensions is not empty.

template<typename ValueType>

gmx::H5mdScalarFrameDataSet< ValueType >::H5mdScalarFrameDataSet	(	hid_t	container,
		const char *	name
	)

Initial value:

{
    throwUponH5mdError(!this->frameDims().empty(),
                       formatString("Could not create scalar frame data set: frame dimension "
                                    "must be empty but had %lu values.",
                                    this->frameDims().size()))

Constructor to open an existing data set (called name, in container).

Exceptions

gmx::FileIOError

if the data set frame dimensions is not empty.

Member Function Documentation

template<typename ValueType>

void gmx::H5mdScalarFrameDataSet< ValueType >::readFrame	(	hsize_t	frameIndex,
		ValueType *	value
	)

Read data from frame at index into value.

Parameters

[in]	frameIndex	Frame index to read data from.
[out]	value	Value into which to read data.

Exceptions

gmx::FileIOError

if an error occurred when reading the data.

template<typename ValueType>

void gmx::H5mdScalarFrameDataSet< ValueType >::writeNextFrame

(

const ValueType &

value

)

Write data from values into the next frame.

Parameters

[in]

value

Value to write.

Exceptions

gmx::FileIOError

if an error occurred when writing the data.

---

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

• src/gromacs/fileio/h5md/h5md_framedataset.h
• src/gromacs/fileio/h5md/h5md_framedataset.cpp