h5 types

Detailed Description

Map C++ datatypes to their corresponding HDF5 datatypes and other related functionality.

Classes
struct	h5::dcplx_t
	A complex compound type consisting of two doubles to represent a complex number. More...

Functions
datatype	h5::get_hdf5_attribute_type (object obj, std::string const &name)
	Get the HDF5 type of a named attribute attached to a given h5::object.
datatype	h5::get_hdf5_type (dataset ds)
	Get the HDF5 type stored in a given h5::dataset.
template<typename T>
std::string	h5::get_name_of_h5_type ()
	Get the name of the HDF5 datatype corresponding to a C++ type.
std::string	h5::get_name_of_h5_type (datatype dt)
	Get the name of an h5::datatype (for error messages).
template<typename T>
datatype	h5::hdf5_type ()
	Map a given C++ type to an HDF5 datatype.
bool	h5::hdf5_type_equal (datatype dt1, datatype dt2)
	Check if two HDF5 datatypes are equal.

Variables
template<typename T>
constexpr bool	h5::is_complex_v = detail::_is_complex<T>::value
	Boolean type trait set to true for std::complex types.

Function Documentation

get_hdf5_attribute_type()

datatype h5::get_hdf5_attribute_type ( object obj, std::string const & name )

nodiscard

#include <h5/object.cpp>

Get the HDF5 type of a named attribute attached to a given h5::object.

Parameters

obj	h5::object to which the attribute is attached.
name	Name of the attribute.

Returns

h5::datatype of the given attribute.

Definition at line 199 of file object.cpp.

get_hdf5_type()

datatype h5::get_hdf5_type ( dataset ds )

nodiscard

#include <h5/object.cpp>

Get the HDF5 type stored in a given h5::dataset.

Parameters

ds	h5::dataset.

Returns

h5::datatype of the given h5::dataset.

Definition at line 197 of file object.cpp.

get_name_of_h5_type() [1/2]

template<typename T>

std::string h5::get_name_of_h5_type ( )

nodiscard

#include <h5/object.hpp>

Get the name of the HDF5 datatype corresponding to a C++ type.

Template Parameters

T	C++ type with a registered HDF5 datatype.

Returns

String representation of the datatype.

Definition at line 177 of file object.hpp.

get_name_of_h5_type() [2/2]

std::string h5::get_name_of_h5_type ( datatype dt )

nodiscard

#include <h5/object.cpp>

Get the name of an h5::datatype (for error messages).

Throws an exception if the datatype is not supported.

Parameters

dt	h5::datatype.

Returns

String representation of the datatype.

Definition at line 184 of file object.cpp.

hdf5_type()

template<typename T>

datatype h5::hdf5_type ( )

nodiscard

#include <h5/object.hpp>

Map a given C++ type to an HDF5 datatype.

Template Parameters

T

C++ type.

Returns

h5::datatype object corresponding to the given C++ type.

Definition at line 156 of file object.hpp.

hdf5_type_equal()

bool h5::hdf5_type_equal ( datatype dt1, datatype dt2 )

nodiscard

#include <h5/object.cpp>

Check if two HDF5 datatypes are equal.

For string types, this function only checks if they are both of the class H5T_STRING. It does not take into account the size, character set, etc.

Otherwise, it simply uses H5Tequal. Throws an exception if the HDF5 call fails.

Parameters

dt1	h5::datatype #1.
dt2	h5::datatype #2.

Returns

True, if the two datatypes are equal.

Definition at line 204 of file object.cpp.

Variable Documentation

is_complex_v

template<typename T>

bool h5::is_complex_v = detail::_is_complex<T>::value

constexpr

#include <h5/complex.hpp>

Boolean type trait set to true for std::complex types.

Template Parameters

T	Type to check.

Definition at line 65 of file complex.hpp.