Classes
class	Deflate

class	ExternalFilter

class	ExternalFilters
	utility container for external filters More...

class	Filter
	abstract filter class More...

class	Fletcher32
	Fletcher32 checksum filter. More...

class	NBit
	NBit checksum filter. More...

class	ScaleOffset

class	Shuffle

class	SZip

Typedefs
using	FilterID = H5Z_filter_t

Enumerations
enum	SOScaleType : std::underlying_type< H5Z_SO_scale_type_t >::type { SOScaleType::FLOAT_DSCALE = H5Z_SO_FLOAT_DSCALE, SOScaleType::FLOAT_ESCALE = H5Z_SO_FLOAT_ESCALE, SOScaleType::INT = H5Z_SO_INT }
	character set encoding More...

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

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

std::ostream &	operator<< (std::ostream &stream, const SOScaleType &scale_type)
	stream output operator for CharacterEncoding enumerations 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

◆ SOScaleType

enum hdf5::filter::SOScaleType : std::underlying_type< H5Z_SO_scale_type_t >::type

strong

Enumeration type determining the character encoding used by string types and links.

Enumerator
FLOAT_DSCALE
FLOAT_ESCALE
INT

Function Documentation

◆ is_filter_available()

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

Checks if external filter is installed

Parameters

id	the ID of the filter

Returns: status flag if the filter available

◆ operator<<()

std::ostream& hdf5::filter::operator<<	(	std::ostream &	stream,
		const SOScaleType &	scale_type
	)

Parameters

stream	reference to an output stream
scale_type	reference to a SOScaleType enumeration instance

Returns: modified output stream

Classes

Typedefs

Enumerations

Functions