gmx::H5md Class Reference

#include <gromacs/fileio/h5md.h>

Description

Manager of an H5MD filehandle. The class is designed to read/write data according to de Buyl et al., 2014 (https://doi.org/10.1016/j.cpc.2014.01.018) and https://www.nongnu.org/h5md/h5md.html.

Public Member Functions
	H5md (const std::filesystem::path &fileName, const H5mdFileMode mode)
	Open an H5MD file and manage its filehandle. More...
	H5md (const H5md &)=delete
H5md &	operator= (const H5md &)=delete
	H5md (H5md &&)=delete
H5md &	operator= (H5md &&)=delete

Constructor & Destructor Documentation

gmx::H5md::H5md	(	const std::filesystem::path &	fileName,
		const H5mdFileMode	mode
	)

Open an H5MD file and manage its filehandle.

Parameters

[in]	fileName	Name of the file to open. The same as the file path.
[in]	mode	The mode to open the file.

Exceptions

FileIOError

if fileName is specified and the file cannot be opened.

---

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

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