class Gambit::Printers::HDF5DataSetBasic

Constructable class for doing basic operations on a HDF5 dataset.

#include <hdf5printer_v2.hpp>

Public Functions

	Name
	HDF5DataSetBasic(const std::string & name) HDF5DataSetBasic member functions.
virtual void	create_dataset(hid_t location_id)

Public Functions inherited from Gambit::Printers::HDF5DataSetBase

	Name
	HDF5DataSetBase(const std::string & name, const hid_t hdftype_id) HDF5DataSetBase member functions.
	HDF5DataSetBase(const std::string & name) Version where type is not provided; set to default of -1.
virtual	~HDF5DataSetBase() Destructor.
void	open_dataset(hid_t location_id) Open dataset on disk and obtain HDF5 handles.
void	close_dataset() Close dataset on disk and release handles.
std::size_t	get_dset_length() const Retrieve the current size of the dataset on disk.
bool	dataset_exists(const hid_t loc_id) Check if our dataset exists on disk with the required name at the given location.
void	ensure_dataset_exists(const hid_t loc_id, const std::size_t length) Ensure that a correctly named dataset exists at the target location with the specified length.
void	extend_dset_to(const std::size_t new_size) Extend dataset to the specified size, filling it with default values.
std::string	myname() const Retrieve name of the dataset we are supposed to access.
int	get_type_id() const Retrieve the integer type ID for this dataset.
hid_t	get_hdftype_id() const Retrieve the HDF5 type ID for this dataset.
bool	get_exists_on_disk() const Variable tracking whether the dataset is known to exist in the output file yet.
void	set_exists_on_disk()

Protected Functions inherited from Gambit::Printers::HDF5DataSetBase

	Name
void	ensure_dataset_is_open() const Enforce that the dataset must be open for whatever follows (or else an error is thrown)
hid_t	get_dset_id() const Retrieve the dataset ID for the currently open dataset.
void	extend_dset_by(const std::size_t extend_by) Set the variable that tracks the (virtual) dataset size on disk.
std::pair< hid_t, hid_t >	select_hyperslab(std::size_t offset, std::size_t length) const Obtain memory and dataspace identifiers for writing to a hyperslab in the dataset.

Protected Attributes inherited from Gambit::Printers::HDF5DataSetBase

	Name
hid_t	dset_id HDF5 dataset identifer.
hid_t	hdftype_id HDF5 type ID for this dataset.
int	type_id Integer identifier for the template type of this dataset (determined by derived type)

HDF5DataSetBasic(
    const std::string & name
)

HDF5DataSetBasic member functions.

virtual void create_dataset(
    hid_t location_id
)

Reimplements: Gambit::Printers::HDF5DataSetBase::create_dataset

Create a new dataset at the specified location (implemented in derived class since need to know the type)

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