h5cpp  0.3.3
A modern C++ wrapper for the HDF5 C library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Typedefs | Enumerations | Functions
hdf5::filter Namespace Reference

Classes

class  Deflate
 
class  ExternalFilter
 
class  Filter
 abstract filter class More...
 
class  Fletcher32
 Fletcher32 checksum filter. More...
 
class  Shuffle
 

Typedefs

using FilterID = H5Z_filter_t
 

Enumerations

enum  Availability : unsigned int { Availability::MANDATORY = H5Z_FLAG_MANDATORY, Availability::OPTIONAL = H5Z_FLAG_OPTIONAL }
 availability requirement of a filter More...
 

Functions

DLL_EXPORT bool is_filter_available (FilterID id)
 is filter available More...
 

Typedef Documentation

◆ FilterID

using hdf5::filter::FilterID = typedef H5Z_filter_t

Enumeration Type Documentation

◆ Availability

enum hdf5::filter::Availability : unsigned int
strong

When a filter is applied to a dataset creation property list the user in general must declare a degree of availability for the filter. A filter can be either optional or mandatory. In the former case the filter is simply omitted if not available (for instance an external filter) in the latter case the operation fails if the filter is not available.

This enumeration type is used to mark a filter as optional or mandatory.

Enumerator
MANDATORY 
OPTIONAL 

Function Documentation

◆ is_filter_available()

DLL_EXPORT bool hdf5::filter::is_filter_available ( FilterID  id)

Checks if external filter is installed

Parameters
idthe ID of the filter
Returns
status flag if the filter available