MCKL
Monte Carlo Kernel Library
Public Member Functions | Static Public Member Functions | List of all members
mckl::HDF5DataSet Class Reference

RAII class for HDF5 data set. More...

#include <mckl/utility/hdf5.hpp>

Inherits mckl::HDF5ID< HDF5DataSet >.

Public Member Functions

 HDF5DataSet ()=default
 
 HDF5DataSet (const HDF5File &file, const std::string &name)
 
 HDF5DataSet (const HDF5Group &group, const std::string &name)
 
 HDF5DataSet (const HDF5File &file, const std::string &name, const HDF5DataType &type, const HDF5DataSpace &space)
 
 HDF5DataSet (const HDF5Group &group, const std::string &name, const HDF5DataType &type, const HDF5DataSpace &space)
 
bool read (const HDF5DataType &type, void *mem) const
 
HDF5DataSpace space () const
 
HDF5DataType type () const
 
bool write (const HDF5DataType &type, const void *mem) const
 
- Public Member Functions inherited from mckl::HDF5ID< HDF5DataSet >
 HDF5ID ()
 
 HDF5ID (::hid_t id)
 
 HDF5ID (const HDF5ID &other)
 
 HDF5ID (HDF5ID &&other)
 
 ~HDF5ID ()
 
bool good () const
 
::hid_t id () const
 
 operator bool () const
 
bool operator! () const
 
HDF5IDoperator= (const HDF5ID &other)
 
HDF5IDoperator= (HDF5ID &&other)
 

Static Public Member Functions

static void close (::hid_t id)
 
::hid_t copy (::hid_t)=delete
 

Additional Inherited Members

- Protected Attributes inherited from mckl::HDF5ID< HDF5DataSet >
::hid_t id_
 

Detailed Description

RAII class for HDF5 data set.

Definition at line 392 of file hdf5.hpp.

Constructor & Destructor Documentation

◆ HDF5DataSet() [1/5]

mckl::HDF5DataSet::HDF5DataSet ( )
default

◆ HDF5DataSet() [2/5]

mckl::HDF5DataSet::HDF5DataSet ( const HDF5File file,
const std::string &  name 
)
inline

Definition at line 399 of file hdf5.hpp.

◆ HDF5DataSet() [3/5]

mckl::HDF5DataSet::HDF5DataSet ( const HDF5Group group,
const std::string &  name 
)
inline

Definition at line 404 of file hdf5.hpp.

◆ HDF5DataSet() [4/5]

mckl::HDF5DataSet::HDF5DataSet ( const HDF5File file,
const std::string &  name,
const HDF5DataType type,
const HDF5DataSpace space 
)
inline

Definition at line 410 of file hdf5.hpp.

◆ HDF5DataSet() [5/5]

mckl::HDF5DataSet::HDF5DataSet ( const HDF5Group group,
const std::string &  name,
const HDF5DataType type,
const HDF5DataSpace space 
)
inline

Definition at line 417 of file hdf5.hpp.

Member Function Documentation

◆ close()

static void mckl::HDF5DataSet::close ( ::hid_t  id)
inlinestatic

Definition at line 450 of file hdf5.hpp.

◆ copy()

::hid_t mckl::HDF5DataSet::copy ( ::hid_t  )
staticdelete

◆ read()

bool mckl::HDF5DataSet::read ( const HDF5DataType type,
void *  mem 
) const
inline

Definition at line 438 of file hdf5.hpp.

◆ space()

HDF5DataSpace mckl::HDF5DataSet::space ( ) const
inline

Definition at line 424 of file hdf5.hpp.

◆ type()

HDF5DataType mckl::HDF5DataSet::type ( ) const
inline

Definition at line 426 of file hdf5.hpp.

◆ write()

bool mckl::HDF5DataSet::write ( const HDF5DataType type,
const void *  mem 
) const
inline

Definition at line 428 of file hdf5.hpp.