H5Easy::DumpOptions Class Reference

Options for dumping data. More...

#include <H5Easy.hpp>

Public Member Functions
	DumpOptions ()=default
	Constructor: accept all defaults.
template<class... Args>
	DumpOptions (Args... args)
	Constructor: overwrite (some of the) defaults.
void	set (DumpMode mode)
	Overwrite setting.
void	set (Flush mode)
	Overwrite setting.
void	set (const Compression &level)
	Overwrite setting.
template<class T , class... Args>
void	set (T arg, Args... args)
	Overwrite settings.
template<class T >
void	setChunkSize (const std::vector< T > &shape)
	Set chunk-size. If the input is rank (size) zero, automatic chunking is enabled.
void	setChunkSize (std::initializer_list< size_t > shape)
	Set chunk-size. If the input is rank (size) zero, automatic chunking is enabled.
bool	overwrite () const
	Check to overwrite.
bool	flush () const
	Check to flush.
bool	compress () const
	Check to compress.
unsigned	getCompressionLevel () const
	Get compression level.
bool	isChunked () const
	Check if chunk-size is manually set (or should be computed automatically).
std::vector< hsize_t >	getChunkSize () const
	Get chunk size.

Detailed Description

Options for dumping data.

By default:

• DumpMode::Create
• Flush::True
• Compression(false)
• ChunkSize: automatic.

Constructor & Destructor Documentation

DumpOptions()

template<class... Args>

H5Easy::DumpOptions::DumpOptions ( Args... args )

inline

Constructor: overwrite (some of the) defaults.

Parameters

Any	of DumpMode, Flush, Compression in arbitrary number and order.

Member Function Documentation

set() [1/4]

void H5Easy::DumpOptions::set ( const Compression & level )

inline

Overwrite setting.

Parameters

level

Compression.

set() [2/4]

void H5Easy::DumpOptions::set ( DumpMode mode )

inline

Overwrite setting.

Parameters

mode

DumpMode.

set() [3/4]

void H5Easy::DumpOptions::set ( Flush mode )

inline

Overwrite setting.

Parameters

flush

Flush.

set() [4/4]

template<class T , class... Args>

void H5Easy::DumpOptions::set ( T arg, Args... args )

inline

Overwrite settings.

Parameters

Any	of DumpMode, Flush, Compression in arbitrary number and order.

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:

• /github/workspace/include/h5gt/H5Easy.hpp
• /github/workspace/include/h5gt/h5easy_bits/H5Easy_public.hpp