H5Easy::DumpOptions Class Reference

Define options for dumping data. More...

#include <H5Easy.hpp>

Public Member Functions
	DumpOptions ()=default
	Constructor: accept all default settings.
template<class... Args>
	DumpOptions (Args... args)
	Constructor: overwrite (some of the) defaults.
void	set (DumpMode mode)
	Overwrite H5Easy::DumpMode setting.
void	set (Flush mode)
	Overwrite H5Easy::Flush setting.
void	set (const Compression &level)
	Overwrite H5Easy::Compression setting.
template<class T , class... Args>
void	set (T arg, Args... args)
	Overwrite any setting(s).
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
	Get overwrite-mode.
bool	flush () const
	Get flush-mode.
bool	compress () const
	Get compress-mode.
unsigned	getCompressionLevel () const
	Get compression level.
bool	isChunked () const
	Get chunking mode: true is manually set, false if chunk-size should be computed automatically.
std::vector< hsize_t >	getChunkSize () const
	Get chunk size. Use DumpOptions::getChunkSize to check if chunk-size should be automatically computed.

Detailed Description

Define options for dumping data.

By default:

• DumpMode::Create
• Flush::True
• Compression: false
• ChunkSize: automatic

Constructor & Destructor Documentation

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

args	any of DumpMode(), Flush(), Compression() in arbitrary number and order.

Member Function Documentation

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

Get chunk size. Use DumpOptions::getChunkSize to check if chunk-size should be automatically computed.

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

Overwrite H5Easy::Compression setting.

Parameters

level

Compression.

set() [2/4]

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

inline

Overwrite H5Easy::DumpMode setting.

Parameters

mode

DumpMode.

set() [3/4]

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

inline

Overwrite H5Easy::Flush setting.

Parameters

mode

Flush.

set() [4/4]

template<class T , class... Args>

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

inline

Overwrite any setting(s).

Parameters

arg	any of DumpMode(), Flush(), Compression in arbitrary number and order.
args	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:

• highfive/H5Easy.hpp
• highfive/h5easy_bits/H5Easy_public.hpp