hdf5 Namespace Reference

Namespaces
	attribute
	dataspace
	datatype
	error
	file
	filter
	node
	property

Classes
class	ArrayAdapter
	adapter for C-style arrays More...
class	Context
class	FixedLengthStringBuffer
struct	FixedLengthStringTrait
struct	FixedLengthStringTrait< std::string >
struct	FixedLengthStringTrait< std::vector< std::string > >
class	IOReadBuffer
class	IOWriteBuffer
class	Iterator
class	IteratorConfig
	iterator configuration More...
class	ObjectHandle
	Wrapper for hid_t object identifiers. More...
class	ObjectId
	Unique ID of an HDF5 object. More...
class	Path
	path to a node object More...
struct	VarLengthBufferTrait
	variable length buffer trait More...
struct	VarLengthStringTrait
	variable length string buffer trait More...
struct	VarLengthStringTrait< std::string >
struct	VarLengthStringTrait< std::vector< std::string > >
class	Version
	a 3 number version class More...

Typedefs
using	Dimensions = std::vector< hsize_t >
using	VarLengthDataBuffer = std::vector< hvl_t >
template<typename CharT >
using	VarLengthStringBuffer = std::vector< CharT * >
	buffer for variable length string data More...

Enumerations
enum	IterationOrder : std::underlying_type< H5_iter_order_t >::type { IterationOrder::INCREASING = H5_ITER_INC, IterationOrder::DECREASING = H5_ITER_DEC, IterationOrder::NATIVE = H5_ITER_NATIVE }
	iteration order More...
enum	IterationIndex : std::underlying_type< H5_index_t >::type { IterationIndex::NAME = H5_INDEX_NAME, IterationIndex::CREATION_ORDER = H5_INDEX_CRT_ORDER }
	iteration index More...

Functions
DLL_EXPORT Iterator	operator+ (const Iterator &a, ssize_t b)
DLL_EXPORT Iterator	operator+ (ssize_t a, const Iterator &b)
DLL_EXPORT Iterator	operator- (const Iterator &a, ssize_t b)
DLL_EXPORT ssize_t	operator- (const Iterator &a, const Iterator &b)
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const IterationIndex &index)
DLL_EXPORT bool	operator== (const ObjectHandle &lhs, const ObjectHandle &rhs)
	equality operator More...
DLL_EXPORT bool	operator!= (const ObjectHandle &lhs, const ObjectHandle &rhs)
	not equal to operator More...
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const ObjectHandle::Type &type)
	output operator for Types More...
DLL_EXPORT bool	operator!= (const Path &lhs, const Path &rhs)
DLL_EXPORT Path	operator+ (const Path &lhs, const Path &rhs)
DLL_EXPORT std::ostream &	operator<< (std::ostream &stream, const Path &path)
DLL_EXPORT bool	operator<= (const Version &lhs, const Version &rhs)
	checks if the left version is smaller or equal to the right More...
template<typename T >
Dimensions	get_dimensions (const ArrayAdapter< T > adapter)
	get dimensions for an array adapter instance More...

Typedef Documentation

Dimensions

using hdf5::Dimensions = typedef std::vector<hsize_t>

VarLengthDataBuffer

using hdf5::VarLengthDataBuffer = typedef std::vector<hvl_t>

VarLengthStringBuffer

template<typename CharT >

using hdf5::VarLengthStringBuffer = typedef std::vector<CharT*>

Variable length string requires and intermediate data structure to be transfered from and to disk. This template provides the basic buffer type used to transfer data.

Template Parameters

CharT

the character tyep used for the strings

Enumeration Type Documentation

IterationIndex

enum hdf5::IterationIndex : std::underlying_type< H5_index_t >::type

strong

Enumerator
NAME	using the name as index
CREATION_ORDER	using creation time as index

IterationOrder

enum hdf5::IterationOrder : std::underlying_type< H5_iter_order_t >::type

strong

This enumeration is used to control how an iterator traverses an iterable with a particular index.

Enumerator
INCREASING	iteration in increasing index order
DECREASING	iteration in decreasing index order
NATIVE	iteration in native index order

Function Documentation

get_dimensions()

template<typename T >

Dimensions hdf5::get_dimensions

(

const ArrayAdapter< T >

adapter

)

This utility function returns the dimensions of a particular array adapter instance.

Template Parameters

T	type of the array elements

Parameters

adapter

reference to the array adapter for which to get the dimensions

Returns

Dimensions instance with the actual dimensions of the array adapter

operator!=() [1/2]

DLL_EXPORT bool hdf5::operator!=	(	const ObjectHandle &	lhs,
		const ObjectHandle &	rhs
	)

Simply the inverse of the == operator.

operator!=() [2/2]

DLL_EXPORT bool hdf5::operator!=	(	const Path &	lhs,
		const Path &	rhs
	)

operator+() [1/3]

DLL_EXPORT Iterator hdf5::operator+	(	const Iterator &	a,
		ssize_t	b
	)

operator+() [2/3]

DLL_EXPORT Iterator hdf5::operator+	(	ssize_t	a,
		const Iterator &	b
	)

operator+() [3/3]

DLL_EXPORT Path hdf5::operator+	(	const Path &	lhs,
		const Path &	rhs
	)

operator-() [1/2]

DLL_EXPORT Iterator hdf5::operator-	(	const Iterator &	a,
		ssize_t	b
	)

operator-() [2/2]

DLL_EXPORT ssize_t hdf5::operator-	(	const Iterator &	a,
		const Iterator &	b
	)

operator<<() [1/3]

DLL_EXPORT std::ostream& hdf5::operator<<	(	std::ostream &	stream,
		const IterationIndex &	index
	)

operator<<() [2/3]

DLL_EXPORT std::ostream& hdf5::operator<<	(	std::ostream &	stream,
		const ObjectHandle::Type &	type
	)

operator<<() [3/3]

DLL_EXPORT std::ostream& hdf5::operator<<	(	std::ostream &	stream,
		const Path &	path
	)

operator<=()

DLL_EXPORT bool hdf5::operator<=	(	const Version &	lhs,
		const Version &	rhs
	)

Parameters

lhs	reference to the left hand side version
rhs	reference to the right hand side version

operator==()

DLL_EXPORT bool hdf5::operator==	(	const ObjectHandle &	lhs,
		const ObjectHandle &	rhs
	)

Two instances of ObjectHandle are considered equal when their internal representation have equal value. This is not a sufficient criteria for object equality!