Define options for dumping data.
More...
#include <H5Easy.hpp>
Define options for dumping data.
By default:
◆ DumpOptions() [1/2]
H5Easy::DumpOptions::DumpOptions |
( |
| ) |
|
|
default |
Constructor: accept all default settings.
◆ DumpOptions() [2/2]
template<class... Args>
H5Easy::DumpOptions::DumpOptions |
( |
Args... |
args | ) |
|
|
inline |
Constructor: overwrite (some of the) defaults.
- Parameters
-
◆ compress()
bool H5Easy::DumpOptions::compress |
( |
| ) |
const |
|
inline |
Get compress-mode.
- Returns
- bool
◆ flush()
bool H5Easy::DumpOptions::flush |
( |
| ) |
const |
|
inline |
Get flush-mode.
- Returns
- bool
◆ getChunkSize()
std::vector< hsize_t > H5Easy::DumpOptions::getChunkSize |
( |
| ) |
const |
|
inline |
◆ getCompressionLevel()
unsigned H5Easy::DumpOptions::getCompressionLevel |
( |
| ) |
const |
|
inline |
Get compression level.
- Returns
- [0..9]
◆ isChunked()
bool H5Easy::DumpOptions::isChunked |
( |
| ) |
const |
|
inline |
Get chunking mode: true
is manually set, false
if chunk-size should be computed automatically.
- Returns
- bool
◆ overwrite()
bool H5Easy::DumpOptions::overwrite |
( |
| ) |
const |
|
inline |
Get overwrite-mode.
- Returns
- bool
◆ set() [1/4]
void H5Easy::DumpOptions::set |
( |
const Compression & |
level | ) |
|
|
inline |
◆ set() [2/4]
void H5Easy::DumpOptions::set |
( |
DumpMode |
mode | ) |
|
|
inline |
◆ set() [3/4]
void H5Easy::DumpOptions::set |
( |
Flush |
mode | ) |
|
|
inline |
◆ set() [4/4]
template<class T , class... Args>
void H5Easy::DumpOptions::set |
( |
T |
arg, |
|
|
Args... |
args |
|
) |
| |
|
inline |
Overwrite any setting(s).
- Parameters
-
◆ setChunkSize() [1/2]
template<class T >
void H5Easy::DumpOptions::setChunkSize |
( |
const std::vector< T > & |
shape | ) |
|
|
inline |
Set chunk-size. If the input is rank (size) zero, automatic chunking is enabled.
- Parameters
-
shape | Chunk size along each dimension. |
◆ setChunkSize() [2/2]
void H5Easy::DumpOptions::setChunkSize |
( |
std::initializer_list< size_t > |
shape | ) |
|
|
inline |
Set chunk-size. If the input is rank (size) zero, automatic chunking is enabled.
- Parameters
-
shape | Chunk size along each dimension. |
The documentation for this class was generated from the following files:
- /builddir/build/BUILD/HighFive-2.3.1/include/highfive/H5Easy.hpp
- /builddir/build/BUILD/HighFive-2.3.1/include/highfive/h5easy_bits/H5Easy_public.hpp