hops
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
H5Easy::DumpOptions Class Reference

Options for dumping data. More...

#include <H5Easy.hpp>

Collaboration diagram for H5Easy::DumpOptions:
Collaboration graph

Public Member Functions

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

Detailed Description

Options for dumping data.

By default:

Constructor & Destructor Documentation

◆ DumpOptions() [1/2]

H5Easy::DumpOptions::DumpOptions ( )
default

Constructor: accept all defaults.

◆ DumpOptions() [2/2]

template<class... Args>
H5Easy::DumpOptions::DumpOptions ( Args...  args)
inline

Constructor: overwrite (some of the) defaults.

Parameters
Anyof DumpMode, Flush, Compression in arbitrary number and order.

Member Function Documentation

◆ compress()

bool H5Easy::DumpOptions::compress ( ) const
inline

Check to compress.

◆ flush()

bool H5Easy::DumpOptions::flush ( ) const
inline

Check to flush.

◆ getChunkSize()

std::vector< hsize_t > H5Easy::DumpOptions::getChunkSize ( ) const
inline

Get chunk size.

◆ getCompressionLevel()

unsigned H5Easy::DumpOptions::getCompressionLevel ( ) const
inline

Get compression level.

◆ isChunked()

bool H5Easy::DumpOptions::isChunked ( ) const
inline

Check if chunk-size is manually set (or should be computed automatically).

◆ overwrite()

bool H5Easy::DumpOptions::overwrite ( ) const
inline

Check to overwrite.

◆ set() [1/4]

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

Overwrite setting.

Parameters
levelCompression.

◆ set() [2/4]

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

Overwrite setting.

Parameters
modeDumpMode.

◆ set() [3/4]

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

Overwrite setting.

Parameters
flushFlush.

◆ set() [4/4]

template<class T , class... Args>
void H5Easy::DumpOptions::set ( arg,
Args...  args 
)
inline

Overwrite settings.

Parameters
Anyof 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
shapeChunk 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
shapeChunk size along each dimension.

The documentation for this class was generated from the following files: