hdf5::filter Namespace Reference

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 class	Availability : unsigned int { Mandatory = H5Z_FLAG_MANDATORY , 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 ScaleOffset::ScaleType &scale_type)
	stream output operator for CharacterEncoding enumerations More...
std::ostream &	operator<< (std::ostream &stream, const SZip::OptionMask &flags)
SZip::OptionMaskBase	operator| (const SZip::OptionMask &lhs, const SZip::OptionMask &rhs)
SZip::OptionMaskBase	operator| (const SZip::OptionMaskBase &lhs, const SZip::OptionMask &rhs)
SZip::OptionMaskBase	operator| (const SZip::OptionMask &lhs, const SZip::OptionMaskBase &rhs)
SZip::OptionMaskBase	operator& (const SZip::OptionMask &lhs, const SZip::OptionMask &rhs)
SZip::OptionMaskBase	operator& (const SZip::OptionMaskBase &lhs, const SZip::OptionMask &rhs)
SZip::OptionMaskBase	operator& (const SZip::OptionMask &lhs, const SZip::OptionMaskBase &rhs)
bool	operator== (const SZip::OptionMask &lhs, const SZip::OptionMask &rhs)
bool	operator== (const SZip::OptionMaskBase &lhs, const SZip::OptionMask &rhs)
bool	operator== (const SZip::OptionMask &lhs, const SZip::OptionMaskBase &rhs)
bool	operator!= (const SZip::OptionMask &lhs, const SZip::OptionMask &rhs)
bool	operator!= (const SZip::OptionMaskBase &lhs, const SZip::OptionMask &rhs)
bool	operator!= (const SZip::OptionMask &lhs, const SZip::OptionMaskBase &rhs)

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()

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!=() [1/3]

bool hdf5::filter::operator!=	(	const SZip::OptionMask &	lhs,
		const SZip::OptionMask &	rhs
	)

operator!=() [2/3]

bool hdf5::filter::operator!=	(	const SZip::OptionMask &	lhs,
		const SZip::OptionMaskBase &	rhs
	)

operator!=() [3/3]

bool hdf5::filter::operator!=	(	const SZip::OptionMaskBase &	lhs,
		const SZip::OptionMask &	rhs
	)

operator&() [1/3]

SZip::OptionMaskBase hdf5::filter::operator&	(	const SZip::OptionMask &	lhs,
		const SZip::OptionMask &	rhs
	)

operator&() [2/3]

SZip::OptionMaskBase hdf5::filter::operator&	(	const SZip::OptionMask &	lhs,
		const SZip::OptionMaskBase &	rhs
	)

operator&() [3/3]

SZip::OptionMaskBase hdf5::filter::operator&	(	const SZip::OptionMaskBase &	lhs,
		const SZip::OptionMask &	rhs
	)

operator<<() [1/2]

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

Parameters

stream	reference to an output stream
scale_type	reference to the scala type to write

Returns

modified output stream

operator<<() [2/2]

std::ostream& hdf5::filter::operator<<	(	std::ostream &	stream,
		const SZip::OptionMask &	flags
	)

operator==() [1/3]

bool hdf5::filter::operator==	(	const SZip::OptionMask &	lhs,
		const SZip::OptionMask &	rhs
	)

operator==() [2/3]

bool hdf5::filter::operator==	(	const SZip::OptionMask &	lhs,
		const SZip::OptionMaskBase &	rhs
	)

operator==() [3/3]

bool hdf5::filter::operator==	(	const SZip::OptionMaskBase &	lhs,
		const SZip::OptionMask &	rhs
	)

operator|() [1/3]

SZip::OptionMaskBase hdf5::filter::operator|	(	const SZip::OptionMask &	lhs,
		const SZip::OptionMask &	rhs
	)

operator|() [2/3]

SZip::OptionMaskBase hdf5::filter::operator|	(	const SZip::OptionMask &	lhs,
		const SZip::OptionMaskBase &	rhs
	)

operator|() [3/3]

SZip::OptionMaskBase hdf5::filter::operator|	(	const SZip::OptionMaskBase &	lhs,
		const SZip::OptionMask &	rhs
	)