HighFive Namespace Reference

Classes
class	AllocationTime
	When are datasets allocated? More...
class	AnnotateTraits
class	AtomicType
	create an HDF5 DataType from a C++ type More...
class	AtomicType< char[StrLen]>
class	AtomicType< std::complex< T > >
class	Attribute
	Class representing an Attribute of a DataSet or Group. More...
class	AttributeException
	Exception specific to HighFive Attribute interface. More...
class	AttributePhaseChange
	Set threshold for attribute storage. More...
class	Caching
class	Chunking
class	CompoundType
	Create a compound HDF5 datatype. More...
class	CreateIntermediateGroup
struct	CreationOrder
class	DataSet
	Class representing a dataset. More...
class	DataSetException
	Exception specific to HighFive DataSet interface. More...
class	DataSpace
	Class representing the space (dimensions) of a DataSet. More...
class	DataSpaceException
	Exception specific to HighFive DataSpace interface. More...
class	DataType
	HDF5 Data Type. More...
class	DataTypeException
	Exception specific to HighFive DataType interface. More...
class	Deflate
class	ElementSet
class	EnumType
	Create a enum HDF5 datatype. More...
class	EstimatedLinkInfo
	Set hints as to how many links to expect and their average length. More...
class	Exception
	Basic HighFive Exception class. More...
class	File
	File class. More...
class	FileException
	Exception specific to HighFive File interface. More...
class	FileVersionBounds
	Configure the version bounds for the file. More...
class	FixedLengthStringType
class	Group
	Represents an hdf5 group. More...
class	GroupException
	Exception specific to HighFive Group interface. More...
struct	HDF5ErrMapper
class	HyperSlab
class	IntegerType
	An Integer datatype (i.e. H5T_INTEGER). More...
class	LinkCreationOrder
	Track and index creation order time. More...
class	Logger
	A logger with supporting basic functionality. More...
class	MetadataBlockSize
	Configure the metadata block size to use writing to files. More...
class	MPIOFileAccess
	Configure MPI access for the file. More...
class	MpioNoCollectiveCause
	The cause for non-collective I/O. More...
class	NodeTraits
	NodeTraits: Base class for Group and File. More...
class	Object
class	ObjectException
	Exception specific to HighFive Object interface. More...
class	ObjectInfo
	A class for accessing hdf5 objects info. More...
class	PathTraits
class	ProductSet
	Selects the Cartesian product of slices. More...
class	PropertyException
	Exception specific to HighFive Property interface. More...
class	PropertyList
	HDF5 property Lists. More...
class	PropertyListBase
	Base Class for Property lists, providing global default. More...
class	RawPropertyList
class	Reference
	An HDF5 (object) reference type. More...
class	ReferenceException
	Exception specific to HighFive Reference interface. More...
struct	RegularHyperSlab
class	Selection
	Selection: represent a view on a slice/part of a dataset. More...
class	Shuffle
class	SilenceHDF5
	Utility class to disable HDF5 stack printing inside a scope. More...
class	SliceTraits
class	StringType
class	Szip
class	UseCollectiveIO
class	VariableLengthStringType

Typedefs
template<typename T >
using	unqualified_t = typename std::remove_const< typename std::remove_reference< T >::type >::type
using	FileCreateProps = PropertyList< PropertyType::FILE_CREATE >
using	FileAccessProps = PropertyList< PropertyType::FILE_ACCESS >
using	DataSetCreateProps = PropertyList< PropertyType::DATASET_CREATE >
using	DataSetAccessProps = PropertyList< PropertyType::DATASET_ACCESS >
using	DataTransferProps = PropertyList< PropertyType::DATASET_XFER >
using	GroupCreateProps = PropertyList< PropertyType::GROUP_CREATE >
using	GroupAccessProps = PropertyList< PropertyType::GROUP_ACCESS >
using	DataTypeCreateProps = PropertyList< PropertyType::DATATYPE_CREATE >
using	DataTypeAccessProps = PropertyList< PropertyType::DATATYPE_ACCESS >
using	StringCreateProps = PropertyList< PropertyType::STRING_CREATE >
using	AttributeCreateProps = PropertyList< PropertyType::ATTRIBUTE_CREATE >
using	LinkCreateProps = PropertyList< PropertyType::LINK_CREATE >
using	LinkAccessProps = PropertyList< PropertyType::LINK_ACCESS >
using	float16_t = half_float::half

Enumerations
enum class	IndexType : std::underlying_type< H5_index_t >::type { NAME = H5_INDEX_NAME , CRT_ORDER = H5_INDEX_CRT_ORDER }
enum class	LinkType { Hard , Soft , External , Other }
	The possible types of group entries (link concept) More...
enum class	StringPadding : std::underlying_type< H5T_str_t >::type { NullTerminated = H5T_STR_NULLTERM , NullPadded = H5T_STR_NULLPAD , SpacePadded = H5T_STR_SPACEPAD }
enum class	DataTypeClass {   Time = 1 << 1 , Integer = 1 << 2 , Float = 1 << 3 , String = 1 << 4 ,   BitField = 1 << 5 , Opaque = 1 << 6 , Compound = 1 << 7 , Reference = 1 << 8 ,   Enum = 1 << 9 , VarLen = 1 << 10 , Array = 1 << 11 , Invalid = 0 }
	Enum of Fundamental data classes. More...
enum class	CharacterSet : std::underlying_type< H5T_cset_t >::type { Ascii = H5T_CSET_ASCII , Utf8 = H5T_CSET_UTF8 }
enum class	ObjectType {   File , Group , UserDataType , DataSpace ,   Dataset , Attribute , Other }
	Enum of the types of objects (H5O api) More...
enum class	PropertyType : int {   PropertyType::FILE_CREATE , PropertyType::FILE_ACCESS , PropertyType::DATASET_CREATE , PropertyType::DATASET_ACCESS ,   PropertyType::DATASET_XFER , PropertyType::GROUP_CREATE , PropertyType::GROUP_ACCESS , PropertyType::DATATYPE_CREATE ,   PropertyType::DATATYPE_ACCESS , PropertyType::STRING_CREATE , PropertyType::ATTRIBUTE_CREATE , PropertyType::LINK_CREATE ,   PropertyType::LINK_ACCESS }
	Types of property lists. More...
enum class	LogSeverity { Debug = HIGHFIVE_LOG_LEVEL_DEBUG , Info = HIGHFIVE_LOG_LEVEL_INFO , Warn = HIGHFIVE_LOG_LEVEL_WARN , Error = HIGHFIVE_LOG_LEVEL_ERROR }

Functions
size_t	compute_total_size (const std::vector< size_t > &dims)
EnumType< details::Boolean >	create_enum_boolean ()
size_t	find_first_atomic_member_size (hid_t hid)
template<typename T >
DataType	create_datatype ()
	Create a DataType instance representing type T.
template<typename T >
DataType	create_and_check_datatype ()
	Create a DataType instance representing type T and perform a sanity check on its size.
template<>
DataType	create_datatype< bool > ()
std::vector< hsize_t >	toHDF5SizeVector (const std::vector< size_t > &from)
std::vector< size_t >	toSTLSizeVector (const std::vector< hsize_t > &from)
DataTypeClass	operator| (DataTypeClass lhs, DataTypeClass rhs)
DataTypeClass	operator& (DataTypeClass lhs, DataTypeClass rhs)
File::AccessMode	operator| (File::AccessMode lhs, File::AccessMode rhs)
File::AccessMode	operator& (File::AccessMode lhs, File::AccessMode rhs)
File::AccessMode	operator^ (File::AccessMode lhs, File::AccessMode rhs)
File::AccessMode	operator~ (File::AccessMode mode)
const File::AccessMode &	operator|= (File::AccessMode &lhs, File::AccessMode rhs)
File::AccessMode	operator&= (File::AccessMode &lhs, File::AccessMode rhs)
File::AccessMode	operator^= (File::AccessMode &lhs, File::AccessMode rhs)
bool	any (File::AccessMode mode)
std::string	to_string (LogSeverity severity)
void	default_logging_callback (LogSeverity severity, const std::string &message, const std::string &file, int line)
Logger &	get_global_logger ()
	Obtain a reference to the logger used by HighFive.
void	register_logging_callback (Logger::callback_type cb)
	Sets the callback that's used by the logger.

Typedef Documentation

float16_t

using HighFive::float16_t = typedef half_float::half

unqualified_t

template<typename T >

using HighFive::unqualified_t = typedef typename std::remove_const<typename std::remove_reference<T>::type>::type

Enumeration Type Documentation

CharacterSet

enum class HighFive::CharacterSet : std::underlying_type< H5T_cset_t >::type

strong

Enumerator
Ascii
Utf8

DataTypeClass

enum class HighFive::DataTypeClass

strong

Enum of Fundamental data classes.

Enumerator
Time
Integer
Float
String
BitField
Opaque
Compound
Reference
Enum
VarLen
Array
Invalid

IndexType

enum class HighFive::IndexType : std::underlying_type< H5_index_t >::type

strong

Enumerator
NAME
CRT_ORDER

LinkType

enum class HighFive::LinkType

strong

The possible types of group entries (link concept)

Enumerator
Hard
Soft
External
Other

LogSeverity

enum class HighFive::LogSeverity

strong

Enumerator
Debug
Info
Warn
Error

ObjectType

enum class HighFive::ObjectType

strong

Enum of the types of objects (H5O api)

Enumerator
File
Group
UserDataType
DataSpace
Dataset
Attribute
Other

StringPadding

enum class HighFive::StringPadding : std::underlying_type< H5T_str_t >::type

strong

Enumerator
NullTerminated
NullPadded
SpacePadded

Function Documentation

any()

bool HighFive::any ( File::AccessMode  mode )

inline

compute_total_size()

size_t HighFive::compute_total_size ( const std::vector< size_t > &  dims )

inline

create_and_check_datatype()

template<typename T >

DataType HighFive::create_and_check_datatype ( )

inline

Create a DataType instance representing type T and perform a sanity check on its size.

create_datatype()

template<typename T >

DataType HighFive::create_datatype ( )

inline

Create a DataType instance representing type T.

create_datatype< bool >()

template<>

DataType HighFive::create_datatype< bool > ( )

inline

create_enum_boolean()

EnumType< details::Boolean > HighFive::create_enum_boolean ( )

inline

default_logging_callback()

void HighFive::default_logging_callback ( LogSeverity  severity, const std::string &  message, const std::string &  file, int  line  )

inline

find_first_atomic_member_size()

size_t HighFive::find_first_atomic_member_size ( hid_t  hid )

inline

get_global_logger()

Logger & HighFive::get_global_logger ( )

inline

Obtain a reference to the logger used by HighFive.

This uses a Meyers singleton, to ensure that the global logger is initialized with a safe default logger, before it is used.

Note: You probably don't need to call this function explicitly.

operator&() [1/2]

DataTypeClass HighFive::operator& ( DataTypeClass  lhs, DataTypeClass  rhs  )

inline

operator&() [2/2]

File::AccessMode HighFive::operator& ( File::AccessMode  lhs, File::AccessMode  rhs  )

inline

operator&=()

File::AccessMode HighFive::operator&= ( File::AccessMode &  lhs, File::AccessMode  rhs  )

inline

operator^()

File::AccessMode HighFive::operator^ ( File::AccessMode  lhs, File::AccessMode  rhs  )

inline

operator^=()

File::AccessMode HighFive::operator^= ( File::AccessMode &  lhs, File::AccessMode  rhs  )

inline

operator|() [1/2]

DataTypeClass HighFive::operator| ( DataTypeClass  lhs, DataTypeClass  rhs  )

inline

operator|() [2/2]

File::AccessMode HighFive::operator| ( File::AccessMode  lhs, File::AccessMode  rhs  )

inline

operator|=()

const File::AccessMode & HighFive::operator|= ( File::AccessMode &  lhs, File::AccessMode  rhs  )

inline

operator~()

File::AccessMode HighFive::operator~ ( File::AccessMode  mode )

inline

register_logging_callback()

void HighFive::register_logging_callback ( Logger::callback_type  cb )

inline

Sets the callback that's used by the logger.

to_string()

std::string HighFive::to_string ( LogSeverity  severity )

inline

toHDF5SizeVector()

std::vector< hsize_t > HighFive::toHDF5SizeVector ( const std::vector< size_t > &  from )

inline

toSTLSizeVector()

std::vector< size_t > HighFive::toSTLSizeVector ( const std::vector< hsize_t > &  from )

inline