hdf5::file Namespace Reference

Classes
class	DirectDriver
	direct write without buffering (for hdf5 compiled with H5_HAVE_DIRECT) More...
class	Driver
	abstract class for file drivers More...
class	File
class	MemoryDriver
	memory file driver More...
class	MPIDriver
	class for the MPI driver (for hdf5 with compiled MPI) More...
class	PosixDriver

Typedefs
using	AccessFlagsBase = std::underlying_type< AccessFlags >::type
using	ImageFlagsBase = std::underlying_type< ImageFlags >::type
using	SearchFlagsBase = std::underlying_type< SearchFlags >::type
using	ScopeBase = std::underlying_type< Scope >::type

Enumerations
enum	DriverID : unsigned { DriverID::Posix = 1, DriverID::Direct = 2, DriverID::Memory = 3, DriverID::MPI = 4 }
	enumeration to determine the file driver More...
enum	AccessFlags : unsigned {   AccessFlags::Truncate = 0x0002, AccessFlags::Exclusive = 0x0004, AccessFlags::ReadWrite = 0x0001, AccessFlags::ReadOnly = 0x0000,   AccessFlags::SWMRRead = 0x0040, AccessFlags::SWMRWrite = 0x0020 }
	flags controlling file opening and creation More...
enum	ImageFlags : unsigned {   ImageFlags::ReadOnly = 0x0000, ImageFlags::ReadWrite = H5LT_FILE_IMAGE_OPEN_RW, ImageFlags::DontCopy = H5LT_FILE_IMAGE_DONT_COPY, ImageFlags::DontRelease = H5LT_FILE_IMAGE_DONT_RELEASE,   ImageFlags::All = H5LT_FILE_IMAGE_ALL }
	flags controlling image file opening and getting More...
enum	SearchFlags : unsigned int {   SearchFlags::File = H5F_OBJ_FILE, SearchFlags::Dataset = H5F_OBJ_DATASET, SearchFlags::Group = H5F_OBJ_GROUP, SearchFlags::Datatype = H5F_OBJ_DATATYPE,   SearchFlags::Attribute = H5F_OBJ_ATTR, SearchFlags::All = H5F_OBJ_ALL, SearchFlags::Local = H5F_OBJ_LOCAL }
	flags controlling object search in a file More...
enum	Scope : std::underlying_type< H5F_scope_t >::type { Scope::Local = H5F_SCOPE_LOCAL, Scope::Global = H5F_SCOPE_GLOBAL }
	file scope More...

Functions
File	create (const fs::path &path, AccessFlags flags=AccessFlags::Exclusive, const property::FileCreationList &fcpl=property::FileCreationList(), const property::FileAccessList &fapl=property::FileAccessList())
	create a new file More...
File	create (const fs::path &path, AccessFlagsBase flags, const property::FileCreationList &fcpl=property::FileCreationList(), const property::FileAccessList &fapl=property::FileAccessList())
File	open (const fs::path &path, AccessFlags flags=AccessFlags::ReadOnly, const property::FileAccessList &fapl=property::FileAccessList())
	open an existing file More...
File	open (const fs::path &path, AccessFlagsBase flags, const property::FileAccessList &fapl=property::FileAccessList())
bool	is_hdf5_file (const fs::path &path)
	check if the file reference by the path is an HDF5 file More...
template<typename T >
File	from_buffer (T &data, ImageFlags flags=ImageFlags::ReadOnly)
	load an image file from a buffer More...
template<typename T >
File	from_buffer (T &data, ImageFlagsBase flags)
template<typename T >
File	from_buffer (T &data, const datatype::Datatype &mem_type, const dataspace::Dataspace &mem_space, ImageFlagsBase flags)
template<typename T >
File	from_buffer (const T &data, ImageFlags flags=ImageFlags::ReadOnly)
template<typename T >
File	from_buffer (const T &data, ImageFlagsBase flags)
std::ostream &	operator<< (std::ostream &stream, const AccessFlags &flags)
AccessFlagsBase	operator| (const AccessFlags &lhs, const AccessFlags &rhs)
AccessFlagsBase	operator| (const AccessFlagsBase &lhs, const AccessFlags &rhs)
AccessFlagsBase	operator| (const AccessFlags &lhs, const AccessFlagsBase &rhs)
AccessFlagsBase	operator& (const AccessFlags &lhs, const AccessFlags &rhs)
AccessFlagsBase	operator& (const AccessFlagsBase &lhs, const AccessFlags &rhs)
AccessFlagsBase	operator& (const AccessFlags &lhs, const AccessFlagsBase &rhs)
std::ostream &	operator<< (std::ostream &stream, const ImageFlags &flags)
ImageFlagsBase	operator| (const ImageFlags &lhs, const ImageFlags &rhs)
ImageFlagsBase	operator| (const ImageFlagsBase &lhs, const ImageFlags &rhs)
ImageFlagsBase	operator| (const ImageFlags &lhs, const ImageFlagsBase &rhs)
ImageFlagsBase	operator& (const ImageFlags &lhs, const ImageFlags &rhs)
ImageFlagsBase	operator& (const ImageFlagsBase &lhs, const ImageFlags &rhs)
ImageFlagsBase	operator& (const ImageFlags &lhs, const ImageFlagsBase &rhs)
std::ostream &	operator<< (std::ostream &stream, const SearchFlags &flags)
SearchFlagsBase	operator| (const SearchFlags &lhs, const SearchFlags &rhs)
SearchFlagsBase	operator| (const SearchFlags &lhs, const SearchFlagsBase &rhs)
SearchFlagsBase	operator| (const SearchFlagsBase &lhs, const SearchFlags &rhs)
SearchFlagsBase	operator& (const SearchFlags &lhs, const SearchFlags &rhs)
SearchFlagsBase	operator& (const SearchFlags &lhs, const SearchFlagsBase &rhs)
SearchFlagsBase	operator& (const SearchFlagsBase &lhs, const SearchFlags &rhs)
std::ostream &	operator<< (std::ostream &stream, const Scope &scope)

Typedef Documentation

AccessFlagsBase

using hdf5::file::AccessFlagsBase = typedef std::underlying_type<AccessFlags>::type

ImageFlagsBase

using hdf5::file::ImageFlagsBase = typedef std::underlying_type<ImageFlags>::type

ScopeBase

using hdf5::file::ScopeBase = typedef std::underlying_type<Scope>::type

SearchFlagsBase

using hdf5::file::SearchFlagsBase = typedef std::underlying_type<SearchFlags>::type

Enumeration Type Documentation

AccessFlags

enum hdf5::file::AccessFlags : unsigned

strong

Enumerator
Truncate
Exclusive
ReadWrite
ReadOnly
SWMRRead	(since hdf5 1.10.0)
SWMRWrite	(since hdf5 1.10.0)

DriverID

enum hdf5::file::DriverID : unsigned

strong

Enumerator
Posix
Direct
Memory
MPI

ImageFlags

enum hdf5::file::ImageFlags : unsigned

strong

Enumerator
ReadOnly
ReadWrite
DontCopy
DontRelease
All

Scope

enum hdf5::file::Scope : std::underlying_type< H5F_scope_t >::type

strong

Enumerator
Local
Global

SearchFlags

enum hdf5::file::SearchFlags : unsigned int

strong

Enumerator
File
Dataset
Group
Datatype
Attribute
All
Local

Function Documentation

create() [1/2]

File hdf5::file::create	(	const fs::path &	path,
		AccessFlags	flags = AccessFlags::Exclusive,
		const property::FileCreationList &	fcpl = property::FileCreationList(),
		const property::FileAccessList &	fapl = property::FileAccessList()
	)

Parameters

path	the path to the new file
flags	HDF5 file creation flags
fcpl	reference to a file creation property list
fapl	reference to a file access property list

Exceptions

std::runtime_error

in case of a failure

Returns

new instance of File

See also

AccessFlags

FileCreationList

FileAccessList

create() [2/2]

File hdf5::file::create	(	const fs::path &	path,
		AccessFlagsBase	flags,
		const property::FileCreationList &	fcpl = property::FileCreationList(),
		const property::FileAccessList &	fapl = property::FileAccessList()
	)

from_buffer() [1/5]

template<typename T >

File hdf5::file::from_buffer	(	const T &	data,
		ImageFlags	flags = ImageFlags::ReadOnly
	)

from_buffer() [2/5]

template<typename T >

File hdf5::file::from_buffer	(	const T &	data,
		ImageFlagsBase	flags
	)

from_buffer() [3/5]

template<typename T >

File hdf5::file::from_buffer	(	T &	data,
		const datatype::Datatype &	mem_type,
		const dataspace::Dataspace &	mem_space,
		ImageFlagsBase	flags
	)

from_buffer() [4/5]

template<typename T >

File hdf5::file::from_buffer	(	T &	data,
		ImageFlags	flags = ImageFlags::ReadOnly
	)

Exceptions

std::runtime_error

in case of a failure

Template Parameters

T	source type

Parameters

data	reference to the source instance of T
flags	file image flags

Returns

a new File instance

See also

ImageFlags

from_buffer() [5/5]

template<typename T >

File hdf5::file::from_buffer	(	T &	data,
		ImageFlagsBase	flags
	)

is_hdf5_file()

bool hdf5::file::is_hdf5_file

(

const fs::path &

path

)

Parameters

path	reference to the files path

Exceptions

std::runtime_error

in case of a failure

Returns

true if the path references an HDF5 file, false otherwise

open() [1/2]

File hdf5::file::open	(	const fs::path &	path,
		AccessFlags	flags = AccessFlags::ReadOnly,
		const property::FileAccessList &	fapl = property::FileAccessList()
	)

Parameters

path	the path to the file to open
flags	file open flags
fapl	reference to a file access property list

Exceptions

std::runtime_error

in case of a failure

Returns

a new File instance

See also

AccessFlags

FileAccessList

open() [2/2]

File hdf5::file::open	(	const fs::path &	path,
		AccessFlagsBase	flags,
		const property::FileAccessList &	fapl = property::FileAccessList()
	)

operator&() [1/9]

AccessFlagsBase hdf5::file::operator&	(	const AccessFlags &	lhs,
		const AccessFlags &	rhs
	)

operator&() [2/9]

AccessFlagsBase hdf5::file::operator&	(	const AccessFlags &	lhs,
		const AccessFlagsBase &	rhs
	)

operator&() [3/9]

AccessFlagsBase hdf5::file::operator&	(	const AccessFlagsBase &	lhs,
		const AccessFlags &	rhs
	)

operator&() [4/9]

ImageFlagsBase hdf5::file::operator&	(	const ImageFlags &	lhs,
		const ImageFlags &	rhs
	)

operator&() [5/9]

ImageFlagsBase hdf5::file::operator&	(	const ImageFlags &	lhs,
		const ImageFlagsBase &	rhs
	)

operator&() [6/9]

ImageFlagsBase hdf5::file::operator&	(	const ImageFlagsBase &	lhs,
		const ImageFlags &	rhs
	)

operator&() [7/9]

SearchFlagsBase hdf5::file::operator&	(	const SearchFlags &	lhs,
		const SearchFlags &	rhs
	)

operator&() [8/9]

SearchFlagsBase hdf5::file::operator&	(	const SearchFlags &	lhs,
		const SearchFlagsBase &	rhs
	)

operator&() [9/9]

SearchFlagsBase hdf5::file::operator&	(	const SearchFlagsBase &	lhs,
		const SearchFlags &	rhs
	)

operator<<() [1/4]

std::ostream& hdf5::file::operator<<	(	std::ostream &	stream,
		const AccessFlags &	flags
	)

operator<<() [2/4]

std::ostream& hdf5::file::operator<<	(	std::ostream &	stream,
		const ImageFlags &	flags
	)

operator<<() [3/4]

std::ostream& hdf5::file::operator<<	(	std::ostream &	stream,
		const Scope &	scope
	)

operator<<() [4/4]

std::ostream& hdf5::file::operator<<	(	std::ostream &	stream,
		const SearchFlags &	flags
	)

operator|() [1/9]

AccessFlagsBase hdf5::file::operator|	(	const AccessFlags &	lhs,
		const AccessFlags &	rhs
	)

operator|() [2/9]

AccessFlagsBase hdf5::file::operator|	(	const AccessFlags &	lhs,
		const AccessFlagsBase &	rhs
	)

operator|() [3/9]

AccessFlagsBase hdf5::file::operator|	(	const AccessFlagsBase &	lhs,
		const AccessFlags &	rhs
	)

operator|() [4/9]

ImageFlagsBase hdf5::file::operator|	(	const ImageFlags &	lhs,
		const ImageFlags &	rhs
	)

operator|() [5/9]

ImageFlagsBase hdf5::file::operator|	(	const ImageFlags &	lhs,
		const ImageFlagsBase &	rhs
	)

operator|() [6/9]

ImageFlagsBase hdf5::file::operator|	(	const ImageFlagsBase &	lhs,
		const ImageFlags &	rhs
	)

operator|() [7/9]

SearchFlagsBase hdf5::file::operator|	(	const SearchFlags &	lhs,
		const SearchFlags &	rhs
	)

operator|() [8/9]

SearchFlagsBase hdf5::file::operator|	(	const SearchFlags &	lhs,
		const SearchFlagsBase &	rhs
	)

operator|() [9/9]

SearchFlagsBase hdf5::file::operator|	(	const SearchFlagsBase &	lhs,
		const SearchFlags &	rhs
	)