gmx::H5mdDataSetBase< ValueType > Class Template Reference

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

Inheritance diagram for gmx::H5mdDataSetBase< ValueType >:

Description

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

Class which manages a HDF5 data set handle and associated data.

Can be made either by opening an existing data set via its name within a container via a public constructor (typically when reading), or via H5mdDataSetBuilder<ValueType> to make a new data set (typically) when writing). The latter is implemented via a private constructor.

Template Parameters

ValueType

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

Public Member Functions
	H5mdDataSetBase (hid_t container, const char *name)
	Constructor to open an existing data set (called name, in container).
	~H5mdDataSetBase () noexcept
	Destructor.
	H5mdDataSetBase (H5mdDataSetBase &&) noexcept
	Move constructor.
H5mdDataSetBase &	operator= (H5mdDataSetBase &&) noexcept
	Move assignment.
hid_t	id () const
	Return the HDF5 handle of the data set. More...
hid_t	dataType () const
	Return the HDF5 handle of the data type for the managed data set. More...
hid_t	nativeDataType () const
	Return the HDF5 handle of the native data type for the managed data set. More...
DataSetDims	dims () const
	Return the dimensions of the data set. More...

Friends
class	H5mdDataSetBuilder< ValueType >

Member Function Documentation

template<typename ValueType >

hid_t gmx::H5mdDataSetBase< ValueType >::dataType

(

)

const

Return the HDF5 handle of the data type for the managed data set.

Warning

Must not be closed by the caller.

Deprecated:

This handle will not be exposed once I/O is implemented as class methods.

template<typename ValueType >

DataSetDims gmx::H5mdDataSetBase< ValueType >::dims

(

)

const

Return the dimensions of the data set.

Exceptions

gmx::FileIOError

if the dimensions cannot be read.

template<typename ValueType >

hid_t gmx::H5mdDataSetBase< ValueType >::id

(

)

const

Return the HDF5 handle of the data set.

Warning

Must not be closed by the caller.

Deprecated:

This handle will not be exposed once I/O is implemented as class methods.

template<typename ValueType >

hid_t gmx::H5mdDataSetBase< ValueType >::nativeDataType

(

)

const

Return the HDF5 handle of the native data type for the managed data set.

Warning

Must not be closed by the caller.

Deprecated:

This handle will not be exposed once I/O is implemented as class methods.

---

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

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