hdf5::property Namespace Reference

Classes
class	AttributeCreationList
class	CreationOrder
class	ChunkCacheParameters
	chunk cache parameter class More...
class	DatasetAccessList
	dataset access property list More...
class	DatasetCreationList
	dataset creation property list More...
class	DatasetTransferList
	class for a dataset transfer property list More...
class	DatatypeAccessList
class	FileAccessList
	file access property list More...
class	FileCreationList
	dataset creation property list More...
class	FileMountList
class	GroupAccessList
class	GroupCreationList
class	LinkAccessList
	link access property list More...
class	LinkCreationList
class	CopyFlags
	encapsulate copy flags More...
class	ObjectCopyList
class	ObjectCreationList
class	Class
	property list class More...
class	List
	base class for property lists More...
class	StringCreationList
class	TypeCreationList
class	VirtualDataMap
	data mapping for virtual datasets More...
class	VirtualDataMaps
	utility container for virtual data maps More...

Typedefs
using	LibVersionBase = std::underlying_type< LibVersion >::type
using	CloseDegreeBase = std::underlying_type< CloseDegree >::type

Enumerations
enum class	VirtualDataView : std::underlying_type< H5D_vds_view_t >::type { FirstMissing = H5D_VDS_FIRST_MISSING , LastAvailable = H5D_VDS_LAST_AVAILABLE }
	virtual data view enumeration (since hdf5 1.10.0) More...
enum class	DatasetFillValueStatus : std::underlying_type< H5D_fill_value_t >::type { Undefined = H5D_FILL_VALUE_UNDEFINED , Default = H5D_FILL_VALUE_DEFAULT , UserDefined = H5D_FILL_VALUE_USER_DEFINED }
	enumeration for the fill value status More...
enum class	DatasetFillTime : std::underlying_type< H5D_fill_time_t >::type { IfSet = H5D_FILL_TIME_IFSET , Alloc = H5D_FILL_TIME_ALLOC , Never = H5D_FILL_TIME_NEVER }
	enumeration for the fill time of a dataset More...
enum class	DatasetAllocTime : std::underlying_type< H5D_alloc_time_t >::type { Default = H5D_ALLOC_TIME_DEFAULT , Early = H5D_ALLOC_TIME_EARLY , Incr = H5D_ALLOC_TIME_INCR , Late = H5D_ALLOC_TIME_LATE }
	enumeration for the dataset allocation time More...
enum class	DatasetLayout : std::underlying_type< H5D_layout_t >::type { Compact = H5D_COMPACT , Contiguous = H5D_CONTIGUOUS , Chunked = H5D_CHUNKED , Virtual = H5D_VIRTUAL }
	enumeration describing the layout of a dataset More...
enum class	MPITransferMode : std::underlying_type< H5FD_mpio_xfer_t >::type { Independent = H5FD_MPIO_INDEPENDENT , Collective = H5FD_MPIO_COLLECTIVE }
enum class	MPIChunkOption : std::underlying_type< H5FD_mpio_chunk_opt_t >::type { OneLinkChunked = H5FD_MPIO_CHUNK_ONE_IO , MultiChunk = H5FD_MPIO_CHUNK_MULTI_IO }
enum class	LibVersion : std::underlying_type< H5F_libver_t >::type { Latest = H5F_LIBVER_LATEST , Earliest = H5F_LIBVER_EARLIEST }
	library version enumeration More...
enum class	CloseDegree : std::underlying_type< H5F_close_degree_t >::type { Weak = H5F_CLOSE_WEAK , Semi = H5F_CLOSE_SEMI , Strong = H5F_CLOSE_STRONG , Default = H5F_CLOSE_DEFAULT }
	close degree enumeration More...
enum class	CopyFlag : unsigned {   ShallowHierarchy = H5O_COPY_SHALLOW_HIERARCHY_FLAG , ExpandSoftLinks = H5O_COPY_EXPAND_SOFT_LINK_FLAG , ExpandExternalLinks = H5O_COPY_EXPAND_EXT_LINK_FLAG , ExpandReferences = H5O_COPY_EXPAND_REFERENCE_FLAG ,   WithoutAttributes = H5O_COPY_WITHOUT_ATTR_FLAG , MergeCommittedTypes = H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG }

Functions
std::ostream &	operator<< (std::ostream &stream, const VirtualDataView &view)
std::ostream &	operator<< (std::ostream &stream, const DatasetFillValueStatus &status)
std::ostream &	operator<< (std::ostream &stream, const DatasetFillTime &time)
std::ostream &	operator<< (std::ostream &stream, const DatasetAllocTime &time)
std::ostream &	operator<< (std::ostream &stream, const DatasetLayout &layout)
std::ostream &	operator<< (std::ostream &stream, const MPITransferMode &mode)
std::ostream &	operator<< (std::ostream &stream, const MPIChunkOption &option)
std::ostream &	operator<< (std::ostream &stream, const LibVersion &version)
std::ostream &	operator<< (std::ostream &stream, const CloseDegree &version)
std::ostream &	operator<< (std::ostream &stream, const CopyFlag &flag)
CopyFlags	operator| (const CopyFlag &lhs, const CopyFlag &rhs)
CopyFlags	operator& (const CopyFlag &lhs, const CopyFlag &rhs)
CopyFlags	operator| (const CopyFlags &flags, const CopyFlags &rhs) noexcept
	binary or operator for copy flags More...
CopyFlags	operator| (const CopyFlags &flags, const CopyFlag &flag) noexcept
	binary or operator for copy flags More...
CopyFlags	operator| (const CopyFlag &flag, const CopyFlags &flags) noexcept
	binary or operator for copy flags More...
CopyFlags	operator& (const CopyFlags &flags, const CopyFlags &rhs) noexcept
	binary and operator for copy flags More...
CopyFlags	operator& (const CopyFlags &flags, const CopyFlag &flag) noexcept
	binary and operator for copy flags More...
CopyFlags	operator& (const CopyFlag &flag, const CopyFlags &flags) noexcept
	binary and operator for copy flags More...
bool	operator== (const Class &lhs, const Class &rhs)
bool	operator!= (const Class &lhs, const Class &rhs)
std::ostream &	operator<< (std::ostream &stream, const Class &c)

Variables
const Class	kAttributeCreate
const Class	kDatasetAccess
const Class	kDatasetCreate
const Class	kDatasetXfer
const Class	kDatatypeAccess
const Class	kDatatypeCreate
const Class	kFileAccess
const Class	kFileCreate
const Class	kFileMount
const Class	kGroupAccess
const Class	kGroupCreate
const Class	kLinkAccess
const Class	kLinkCreate
const Class	kObjectCopy
const Class	kObjectCreate
const Class	kStringCreate
decltype(H5P_DEFAULT) const	kDefault = H5P_DEFAULT

Typedef Documentation

CloseDegreeBase

using hdf5::property::CloseDegreeBase = typedef std::underlying_type<CloseDegree>::type

LibVersionBase

using hdf5::property::LibVersionBase = typedef std::underlying_type<LibVersion>::type

Enumeration Type Documentation

CloseDegree

enum hdf5::property::CloseDegree : std::underlying_type< H5F_close_degree_t >::type

strong

Enumerator
Weak
Semi
Strong
Default

CopyFlag

enum hdf5::property::CopyFlag : unsigned

strong

Enumerator
ShallowHierarchy
ExpandSoftLinks
ExpandExternalLinks
ExpandReferences
WithoutAttributes
MergeCommittedTypes

DatasetAllocTime

enum hdf5::property::DatasetAllocTime : std::underlying_type< H5D_alloc_time_t >::type

strong

The particular allocation strategy depends on the layout of the dataset.

See also

DatasetLayout

Enumerator
Default	choose the default allocation strategy for the particular layout
Early	all space is allocated when the dataset is created
Incr	space is allocated as data is written to the file
Late	all space is allocated at the first write to the dataset

DatasetFillTime

enum hdf5::property::DatasetFillTime : std::underlying_type< H5D_fill_time_t >::type

strong

Enumerator
IfSet
Alloc
Never

DatasetFillValueStatus

enum hdf5::property::DatasetFillValueStatus : std::underlying_type< H5D_fill_value_t >::type

strong

Enumerator
Undefined
Default
UserDefined

DatasetLayout

enum hdf5::property::DatasetLayout : std::underlying_type< H5D_layout_t >::type

strong

Enumerator
Compact
Contiguous
Chunked
Virtual	(since hdf5 1.10.0)

LibVersion

enum hdf5::property::LibVersion : std::underlying_type< H5F_libver_t >::type

strong

Enumerator
Latest
Earliest

MPIChunkOption

enum hdf5::property::MPIChunkOption : std::underlying_type< H5FD_mpio_chunk_opt_t >::type

strong

Enumerator
OneLinkChunked
MultiChunk

MPITransferMode

enum hdf5::property::MPITransferMode : std::underlying_type< H5FD_mpio_xfer_t >::type

strong

Enumerator
Independent
Collective

VirtualDataView

enum hdf5::property::VirtualDataView : std::underlying_type< H5D_vds_view_t >::type

strong

Enumerator
FirstMissing
LastAvailable

Function Documentation

operator!=()

bool hdf5::property::operator!=	(	const Class &	lhs,
		const Class &	rhs
	)

operator&() [1/4]

CopyFlags hdf5::property::operator& ( const CopyFlag &  flag, const CopyFlags &  flags  )

noexcept

operator&() [2/4]

CopyFlags hdf5::property::operator&	(	const CopyFlag &	lhs,
		const CopyFlag &	rhs
	)

operator&() [3/4]

CopyFlags hdf5::property::operator& ( const CopyFlags &  flags, const CopyFlag &  flag  )

noexcept

operator&() [4/4]

CopyFlags hdf5::property::operator& ( const CopyFlags &  flags, const CopyFlags &  rhs  )

noexcept

operator<<() [1/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const Class &	c
	)

operator<<() [2/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const CloseDegree &	version
	)

operator<<() [3/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const CopyFlag &	flag
	)

operator<<() [4/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const DatasetAllocTime &	time
	)

operator<<() [5/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const DatasetFillTime &	time
	)

operator<<() [6/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const DatasetFillValueStatus &	status
	)

operator<<() [7/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const DatasetLayout &	layout
	)

operator<<() [8/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const LibVersion &	version
	)

operator<<() [9/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const MPIChunkOption &	option
	)

operator<<() [10/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const MPITransferMode &	mode
	)

operator<<() [11/11]

std::ostream& hdf5::property::operator<<	(	std::ostream &	stream,
		const VirtualDataView &	view
	)

operator==()

bool hdf5::property::operator==	(	const Class &	lhs,
		const Class &	rhs
	)

operator|() [1/4]

CopyFlags hdf5::property::operator| ( const CopyFlag &  flag, const CopyFlags &  flags  )

noexcept

operator|() [2/4]

CopyFlags hdf5::property::operator|	(	const CopyFlag &	lhs,
		const CopyFlag &	rhs
	)

operator|() [3/4]

CopyFlags hdf5::property::operator| ( const CopyFlags &  flags, const CopyFlag &  flag  )

noexcept

operator|() [4/4]

CopyFlags hdf5::property::operator| ( const CopyFlags &  flags, const CopyFlags &  rhs  )

noexcept

Variable Documentation

kAttributeCreate

const Class hdf5::property::kAttributeCreate

extern

kDatasetAccess

const Class hdf5::property::kDatasetAccess

extern

kDatasetCreate

const Class hdf5::property::kDatasetCreate

extern

kDatasetXfer

const Class hdf5::property::kDatasetXfer

extern

kDatatypeAccess

const Class hdf5::property::kDatatypeAccess

extern

kDatatypeCreate

const Class hdf5::property::kDatatypeCreate

extern

kDefault

decltype(H5P_DEFAULT) const hdf5::property::kDefault = H5P_DEFAULT

kFileAccess

const Class hdf5::property::kFileAccess

extern

kFileCreate

const Class hdf5::property::kFileCreate

extern

kFileMount

const Class hdf5::property::kFileMount

extern

kGroupAccess

const Class hdf5::property::kGroupAccess

extern

kGroupCreate

const Class hdf5::property::kGroupCreate

extern

kLinkAccess

const Class hdf5::property::kLinkAccess

extern

kLinkCreate

const Class hdf5::property::kLinkCreate

extern

kObjectCopy

const Class hdf5::property::kObjectCopy

extern

kObjectCreate

const Class hdf5::property::kObjectCreate

extern

kStringCreate

const Class hdf5::property::kStringCreate

extern