DASH  0.3.0
dash::io::hdf5::hdf5_options Struct Reference

Options which can be passed to dash::io::StoreHDF::write to specify how existing structures are treated and what metadata is stored. More...

#include <StorageDriver.h>

Public Attributes

bool overwrite_file = true
 Overwrite HDF5 file if already existing. More...
 
bool modify_dataset = false
 Modify an already existing HDF5 dataset. More...
 
bool store_pattern = true
 Store dash pattern characteristics as metadata in HDF5 file. More...
 
bool restore_pattern = true
 Restore pattern from metadata if HDF5 file contains any. More...
 
std::string pattern_metadata_key = "DASH_PATTERN"
 Metadata attribute key in HDF5 file. More...
 

Detailed Description

Options which can be passed to dash::io::StoreHDF::write to specify how existing structures are treated and what metadata is stored.

Collective operation.

Examples:
ex.08.io-hdf5/main.cpp.

Definition at line 56 of file StorageDriver.h.

Member Data Documentation

◆ modify_dataset

bool dash::io::hdf5::hdf5_options::modify_dataset = false

Modify an already existing HDF5 dataset.

If the dataset is not existing, throws a runtime error

Definition at line 63 of file StorageDriver.h.

◆ overwrite_file

bool dash::io::hdf5::hdf5_options::overwrite_file = true

Overwrite HDF5 file if already existing.

Definition at line 58 of file StorageDriver.h.

◆ pattern_metadata_key

std::string dash::io::hdf5::hdf5_options::pattern_metadata_key = "DASH_PATTERN"

Metadata attribute key in HDF5 file.

Definition at line 69 of file StorageDriver.h.

◆ restore_pattern

bool dash::io::hdf5::hdf5_options::restore_pattern = true

Restore pattern from metadata if HDF5 file contains any.

Definition at line 67 of file StorageDriver.h.

◆ store_pattern

bool dash::io::hdf5::hdf5_options::store_pattern = true

Store dash pattern characteristics as metadata in HDF5 file.

Definition at line 65 of file StorageDriver.h.


The documentation for this struct was generated from the following file: