Dataspace Class Reference#

DiFfRG: DiFfRG::hdf5::Dataspace Class Reference
DiFfRG

#include <dataspace.hh>

Public Member Functions

 Dataspace ()=default
 
 Dataspace (hid_t id)
 
hid_t id () const noexcept
 
bool valid () const noexcept
 
hssize_t size () const
 Number of elements (product of all extents). For a scalar space this is 1.
 
Dims extents () const
 Current extents.
 
void select_hyperslab (const Dims &offset, const Dims &count)
 

Static Public Member Functions

static Dataspace take (hid_t id)
 
static Dataspace scalar ()
 
static Dataspace simple (const Dims &dims)
 
static Dataspace simple_unlimited (const Dims &dims)
 

Private Member Functions

 Dataspace (Handle h)
 

Private Attributes

Handle h_
 

Constructor & Destructor Documentation

◆ Dataspace() [1/3]

DiFfRG::hdf5::Dataspace::Dataspace ( )
default

◆ Dataspace() [2/3]

DiFfRG::hdf5::Dataspace::Dataspace ( hid_t id)
inlineexplicit

◆ Dataspace() [3/3]

DiFfRG::hdf5::Dataspace::Dataspace ( Handle h)
inlineexplicitprivate

Member Function Documentation

◆ extents()

Dims DiFfRG::hdf5::Dataspace::extents ( ) const
inline

Current extents.

◆ id()

hid_t DiFfRG::hdf5::Dataspace::id ( ) const
inlinenoexcept

◆ scalar()

static Dataspace DiFfRG::hdf5::Dataspace::scalar ( )
inlinestatic

◆ select_hyperslab()

void DiFfRG::hdf5::Dataspace::select_hyperslab ( const Dims & offset,
const Dims & count )
inline

Restrict the selection to a hyperslab [offset, offset+count) along each dim. Stride and block default to 1 (the only pattern DiFfRG uses).

◆ simple()

static Dataspace DiFfRG::hdf5::Dataspace::simple ( const Dims & dims)
inlinestatic

◆ simple_unlimited()

static Dataspace DiFfRG::hdf5::Dataspace::simple_unlimited ( const Dims & dims)
inlinestatic

Simple dataspace with the given current extents and unlimited maximum extents along every axis.

◆ size()

hssize_t DiFfRG::hdf5::Dataspace::size ( ) const
inline

Number of elements (product of all extents). For a scalar space this is 1.

◆ take()

static Dataspace DiFfRG::hdf5::Dataspace::take ( hid_t id)
inlinestatic

◆ valid()

bool DiFfRG::hdf5::Dataspace::valid ( ) const
inlinenoexcept

Member Data Documentation

◆ h_

Handle DiFfRG::hdf5::Dataspace::h_
private

The documentation for this class was generated from the following file:
  • /home/runner/work/DiFfRG_current/DiFfRG_current/DiFfRG/include/hdf5lib/dataspace.hh