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

RAII class for HDF5 data space. More...

#include <mckl/utility/hdf5.hpp>

Inherits mckl::HDF5ID< HDF5DataSpace >.

Public Member Functions

 HDF5DataSpace ()=default
 
 HDF5DataSpace (int rank, ::hsize_t *dim, ::hsize_t *maxdims=nullptr)
 
std::size_t dims (::hsize_t *dest) const
 
std::size_t ndims () const
 
std::size_t npoints () const
 
- Public Member Functions inherited from mckl::HDF5ID< HDF5DataSpace >
 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< HDF5DataSpace >
::hid_t id_
 

Detailed Description

RAII class for HDF5 data space.

Definition at line 294 of file hdf5.hpp.

Constructor & Destructor Documentation

◆ HDF5DataSpace() [1/2]

mckl::HDF5DataSpace::HDF5DataSpace ( )
default

◆ HDF5DataSpace() [2/2]

mckl::HDF5DataSpace::HDF5DataSpace ( int  rank,
::hsize_t *  dim,
::hsize_t *  maxdims = nullptr 
)
inlineexplicit

Definition at line 301 of file hdf5.hpp.

Member Function Documentation

◆ close()

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

Definition at line 325 of file hdf5.hpp.

◆ copy()

::hid_t mckl::HDF5DataSpace::copy ( ::hid_t  )
staticdelete

◆ dims()

std::size_t mckl::HDF5DataSpace::dims ( ::hsize_t *  dest) const
inline

Definition at line 317 of file hdf5.hpp.

◆ ndims()

std::size_t mckl::HDF5DataSpace::ndims ( ) const
inline

Definition at line 312 of file hdf5.hpp.

◆ npoints()

std::size_t mckl::HDF5DataSpace::npoints ( ) const
inline

Definition at line 307 of file hdf5.hpp.