class Gambit::Printers::DataSetInterfaceBase

Wrapper object to manage a single dataset. More…

#include <DataSetInterfaceBase.hpp>

Public Functions

Name
DataSetInterfaceBase()
Constructors.
DataSetInterfaceBase(hid_t location_id, const std::string & name, const std::size_t rdims[DSETRANK], const bool resume, const char access)
virtual~DataSetInterfaceBase()
Do cleanup (close dataset)
hid_tcreateDataSet(hid_t location_id, const std::string & name, const std::size_t rdims[DSETRANK])
Create a (chunked) dataset.
hid_topenDataSet(hid_t location_id, const std::string & name, const std::size_t rdims[DSETRANK])
Open an existing dataset.
voidcloseDataSet()
Close an open dataset.
voidextend_dset(const unsigned long i)
Extend dataset to nearest multiple of CHUNKLENGTH above supplied length.
std::stringget_myname() const
std::size_tget_dsetrank() const
std::size_tget_chunklength() const
const hsize_t *get_maxdsetdims() const
const hsize_t *get_chunkdims() const
const hsize_t *get_slicedims() const
unsigned longget_nextemptyslab() const
unsigned longdset_length() const
characcess_mode() const
voidreset_nextemptyslab()
hsize_t *dsetdims()

Protected Functions

Name
hid_tget_dset_id() const

Protected Attributes

Name
const hid_thdftype_id
DataSetInterfaceBase class member definitions.
hid_tdset_id
unsigned longdsetnextemptyslab
unsigned longvirtualwriteposition

Detailed Description

template <class T ,
std::size_t RECORDRANK,
std::size_t CHUNKLENGTH>
class Gambit::Printers::DataSetInterfaceBase;

Wrapper object to manage a single dataset.

Public Functions Documentation

function DataSetInterfaceBase

DataSetInterfaceBase()

Constructors.

function DataSetInterfaceBase

DataSetInterfaceBase(
    hid_t location_id,
    const std::string & name,
    const std::size_t rdims[DSETRANK],
    const bool resume,
    const char access
)

function ~DataSetInterfaceBase

virtual ~DataSetInterfaceBase()

Do cleanup (close dataset)

function createDataSet

hid_t createDataSet(
    hid_t location_id,
    const std::string & name,
    const std::size_t rdims[DSETRANK]
)

Create a (chunked) dataset.

function openDataSet

hid_t openDataSet(
    hid_t location_id,
    const std::string & name,
    const std::size_t rdims[DSETRANK]
)

Open an existing dataset.

Open an existing dataset It is assumed that we are resuming a run and therefore know what format this dataset should have

function closeDataSet

void closeDataSet()

Close an open dataset.

Release resources associated with the underlying dataset.

function extend_dset

void extend_dset(
    const unsigned long i
)

Extend dataset to nearest multiple of CHUNKLENGTH above supplied length.

function get_myname

inline std::string get_myname() const

function get_dsetrank

inline std::size_t get_dsetrank() const

function get_chunklength

inline std::size_t get_chunklength() const

function get_maxdsetdims

inline const hsize_t * get_maxdsetdims() const

function get_chunkdims

inline const hsize_t * get_chunkdims() const

function get_slicedims

inline const hsize_t * get_slicedims() const

function get_nextemptyslab

inline unsigned long get_nextemptyslab() const

function dset_length

inline unsigned long dset_length() const

function access_mode

inline char access_mode() const

function reset_nextemptyslab

inline void reset_nextemptyslab()

function dsetdims

inline hsize_t * dsetdims()

Protected Functions Documentation

function get_dset_id

inline hid_t get_dset_id() const

Protected Attributes Documentation

variable hdftype_id

static const hid_t hdftype_id = get_hdf5_data_type<T>::type();

DataSetInterfaceBase class member definitions.

variable dset_id

hid_t dset_id;

variable dsetnextemptyslab

unsigned long dsetnextemptyslab;

variable virtualwriteposition

unsigned long virtualwriteposition;

Updated on 2023-06-26 at 21:36:52 +0000