hdf5::property Namespace Reference

Classes
class	AttributeCreationList
class	ChunkCacheParameters
	chunk cache parameter class More...
class	Class
	property list class More...
class	CopyFlags
	encapsulate copy flags More...
class	CreationOrder
class	DatasetAccessList
	dataset access property list More...
class	DatasetCreationList
	dataset creation property list More...
class	DatasetTransferList
class	DatatypeAccessList
class	FileAccessList
	file access property list More...
class	FileCreationList
class	FileMountList
class	GroupAccessList
class	GroupCreationList
class	LinkAccessList
	link access property list More...
class	LinkCreationList
class	List
	base class for property lists More...
class	ObjectCopyList
class	ObjectCreationList
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	DatasetFillValueStatus : std::underlying_type< H5D_fill_value_t >::type { DatasetFillValueStatus::UNDEFINED = H5D_FILL_VALUE_UNDEFINED, DatasetFillValueStatus::DEFAULT = H5D_FILL_VALUE_DEFAULT, DatasetFillValueStatus::USER_DEFINED = H5D_FILL_VALUE_USER_DEFINED }
	enumeration for the fill value status More...
enum	DatasetFillTime : std::underlying_type< H5D_fill_time_t >::type { DatasetFillTime::IFSET = H5D_FILL_TIME_IFSET, DatasetFillTime::ALLOC = H5D_FILL_TIME_ALLOC, DatasetFillTime::NEVER = H5D_FILL_TIME_NEVER }
	enumeration for the fill time of a dataset More...
enum	DatasetAllocTime : std::underlying_type< H5D_alloc_time_t >::type { DatasetAllocTime::DEFAULT = H5D_ALLOC_TIME_DEFAULT, DatasetAllocTime::EARLY = H5D_ALLOC_TIME_EARLY, DatasetAllocTime::INCR = H5D_ALLOC_TIME_INCR, DatasetAllocTime::LATE = H5D_ALLOC_TIME_LATE }
	enumeration for the dataset allocation time More...
enum	DatasetLayout : std::underlying_type< H5D_layout_t >::type { DatasetLayout::COMPACT = H5D_COMPACT, DatasetLayout::CONTIGUOUS = H5D_CONTIGUOUS, DatasetLayout::CHUNKED = H5D_CHUNKED }
	enumeration describing the layout of a dataset More...
enum	LibVersion : std::underlying_type< H5F_libver_t >::type { LibVersion::LATEST = H5F_LIBVER_LATEST, LibVersion::EARLIEST = H5F_LIBVER_EARLIEST }
	library version enumeration More...
enum	CloseDegree : std::underlying_type< H5F_close_degree_t >::type { CloseDegree::WEAK = H5F_CLOSE_WEAK, CloseDegree::SEMI = H5F_CLOSE_SEMI, CloseDegree::STRONG = H5F_CLOSE_STRONG, CloseDegree::DEFAULT = H5F_CLOSE_DEFAULT }
	close degree enumeration More...
enum	CopyFlag : unsigned {   CopyFlag::SHALLOW_HIERARCHY = H5O_COPY_SHALLOW_HIERARCHY_FLAG, CopyFlag::EXPAND_SOFT_LINKS = H5O_COPY_EXPAND_SOFT_LINK_FLAG, CopyFlag::EXPAND_EXTERNAL_LINKS = H5O_COPY_EXPAND_EXT_LINK_FLAG, CopyFlag::EXPAND_REFERENCES = H5O_COPY_EXPAND_REFERENCE_FLAG,   CopyFlag::WITHOUT_ATTRIBUTES = H5O_COPY_WITHOUT_ATTR_FLAG, CopyFlag::MERGE_COMMITTED_TYPES = H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG }

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

Variables
DLL_EXPORT const Class	kAttributeCreate
DLL_EXPORT const Class	kDatasetAccess
DLL_EXPORT const Class	kDatasetCreate
DLL_EXPORT const Class	kDatasetXfer
DLL_EXPORT const Class	kDatatypeAccess
DLL_EXPORT const Class	kDatatypeCreate
DLL_EXPORT const Class	kFileAccess
DLL_EXPORT const Class	kFileCreate
DLL_EXPORT const Class	kFileMount
DLL_EXPORT const Class	kGroupAccess
DLL_EXPORT const Class	kGroupCreate
DLL_EXPORT const Class	kLinkAccess
DLL_EXPORT const Class	kLinkCreate
DLL_EXPORT const Class	kObjectCopy
DLL_EXPORT const Class	kObjectCreate
DLL_EXPORT const Class	kStringCreate

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
SHALLOW_HIERARCHY
EXPAND_SOFT_LINKS
EXPAND_EXTERNAL_LINKS
EXPAND_REFERENCES
WITHOUT_ATTRIBUTES
MERGE_COMMITTED_TYPES

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
USER_DEFINED

DatasetLayout

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

strong

Enumerator
COMPACT
CONTIGUOUS
CHUNKED

LibVersion

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

strong

Enumerator
LATEST
EARLIEST

Function Documentation

operator!=()

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

operator<<() [1/8]

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

operator<<() [2/8]

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

operator<<() [3/8]

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

operator<<() [4/8]

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

operator<<() [5/8]

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

operator<<() [6/8]

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

operator<<() [7/8]

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

operator<<() [8/8]

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

operator==()

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

operator|() [1/4]

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

operator|() [2/4]

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

noexcept

operator|() [3/4]

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

noexcept

operator|() [4/4]

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

noexcept

Variable Documentation

kAttributeCreate

DLL_EXPORT const Class hdf5::property::kAttributeCreate

kDatasetAccess

DLL_EXPORT const Class hdf5::property::kDatasetAccess

kDatasetCreate

DLL_EXPORT const Class hdf5::property::kDatasetCreate

kDatasetXfer

DLL_EXPORT const Class hdf5::property::kDatasetXfer

kDatatypeAccess

DLL_EXPORT const Class hdf5::property::kDatatypeAccess

kDatatypeCreate

DLL_EXPORT const Class hdf5::property::kDatatypeCreate

kFileAccess

DLL_EXPORT const Class hdf5::property::kFileAccess

kFileCreate

DLL_EXPORT const Class hdf5::property::kFileCreate

kFileMount

DLL_EXPORT const Class hdf5::property::kFileMount

kGroupAccess

DLL_EXPORT const Class hdf5::property::kGroupAccess

kGroupCreate

DLL_EXPORT const Class hdf5::property::kGroupCreate

kLinkAccess

DLL_EXPORT const Class hdf5::property::kLinkAccess

kLinkCreate

DLL_EXPORT const Class hdf5::property::kLinkCreate

kObjectCopy

DLL_EXPORT const Class hdf5::property::kObjectCopy

kObjectCreate

DLL_EXPORT const Class hdf5::property::kObjectCreate

kStringCreate

DLL_EXPORT const Class hdf5::property::kStringCreate