HighFive  2.3.1
HighFive - Header-only C++ HDF5 interface
HighFive Namespace Reference

Classes

class  AtomicType
 create an HDF5 DataType from a C++ type More...
 
class  AnnotateTraits
 
class  FixedLenStringArray
 A structure representing a set of fixed-length strings. More...
 
class  NodeTraits
 NodeTraits: Base class for Group and File. More...
 
class  PropertyList
 HDF5 property Lists. More...
 
class  AtomicType< char[StrLen]>
 
class  AtomicType< FixedLenStringArray< StrLen > >
 
struct  HDF5ErrMapper
 
class  PathTraits
 
class  ElementSet
 
class  SliceTraits
 
class  Attribute
 Class representing an attribute of a dataset or group. More...
 
class  DataSet
 Class representing a dataset. More...
 
class  DataSpace
 Class representing the space (dimensions) of a dataset. More...
 
class  DataType
 HDF5 Data Type. More...
 
class  CompoundType
 Create a compound HDF5 datatype. More...
 
class  EnumType
 Create a enum HDF5 datatype. More...
 
class  Exception
 Basic HighFive Exception class. More...
 
class  ObjectException
 Exception specific to HighFive Object interface. More...
 
class  DataTypeException
 Exception specific to HighFive DataType interface. More...
 
class  FileException
 Exception specific to HighFive File interface. More...
 
class  DataSpaceException
 Exception specific to HighFive DataSpace interface. More...
 
class  AttributeException
 Exception specific to HighFive Attribute interface. More...
 
class  DataSetException
 Exception specific to HighFive DataSet interface. More...
 
class  GroupException
 Exception specific to HighFive Group interface. More...
 
class  PropertyException
 Exception specific to HighFive Property interface. More...
 
class  ReferenceException
 Exception specific to HighFive Reference interface. More...
 
class  File
 File class. More...
 
class  FileDriver
 file driver base concept More...
 
class  MPIOFileDriver
 MPIIO Driver for Parallel HDF5. More...
 
class  Group
 Represents an hdf5 group. More...
 
class  Object
 
class  ObjectInfo
 A class for accessing hdf5 objects info. More...
 
class  PropertyListBase
 Base Class for Property lists, providing global default. More...
 
class  RawPropertyList
 
class  Chunking
 
class  Deflate
 
class  Szip
 
class  Shuffle
 
class  Caching
 
class  CreateIntermediateGroup
 
class  Reference
 An HDF5 (object) reference type. More...
 
class  Selection
 Selection: represent a view on a slice/part of a dataset. More...
 
class  SilenceHDF5
 Utility class to disable HDF5 stack printing inside a scope. More...
 

Typedefs

template<typename T >
using unqualified_t = typename std::remove_const< typename std::remove_reference< T >::type >::type
 
typedef PropertyList< PropertyType::OBJECT_CREATEObjectCreateProps
 
typedef PropertyList< PropertyType::FILE_CREATEFileCreateProps
 
typedef PropertyList< PropertyType::FILE_ACCESSFileAccessProps
 
typedef PropertyList< PropertyType::DATASET_CREATEDataSetCreateProps
 
typedef PropertyList< PropertyType::DATASET_ACCESSDataSetAccessProps
 
typedef PropertyList< PropertyType::DATASET_XFERDataTransferProps
 
typedef PropertyList< PropertyType::GROUP_CREATEGroupCreateProps
 
typedef PropertyList< PropertyType::GROUP_ACCESSGroupAccessProps
 
typedef PropertyList< PropertyType::DATATYPE_CREATEDataTypeCreateProps
 
typedef PropertyList< PropertyType::DATATYPE_ACCESSDataTypeAccessProps
 
typedef PropertyList< PropertyType::STRING_CREATEStringCreateProps
 
typedef PropertyList< PropertyType::ATTRIBUTE_CREATEAttributeCreateProps
 
typedef PropertyList< PropertyType::OBJECT_COPYObjectCopyProps
 
typedef PropertyList< PropertyType::LINK_CREATELinkCreateProps
 
typedef PropertyList< PropertyType::LINK_ACCESSLinkAccessProps
 

Enumerations

enum class  LinkType { Hard , Soft , External , Other }
 The possible types of group entries (link concept) More...
 
enum class  DataTypeClass {
  Time , Integer , Float , String ,
  BitField , Opaque , Compound , Reference ,
  Enum , VarLen , Array , Invalid
}
 Enum of Fundamental data classes. More...
 
enum class  ObjectType {
  File , Group , UserDataType , DataSpace ,
  Dataset , Attribute , Other
}
 Enum of the types of objects (H5O api) More...
 
enum class  PropertyType : int {
  OBJECT_CREATE , FILE_CREATE , FILE_ACCESS , DATASET_CREATE ,
  DATASET_ACCESS , DATASET_XFER , GROUP_CREATE , GROUP_ACCESS ,
  DATATYPE_CREATE , DATATYPE_ACCESS , STRING_CREATE , ATTRIBUTE_CREATE ,
  OBJECT_COPY , LINK_CREATE , LINK_ACCESS
}
 Types of property lists. More...
 

Functions

size_t find_first_atomic_member_size (hid_t hid)
 
template<typename T >
DataType create_datatype ()
 Create a DataType instance representing type T. More...
 
template<typename T >
DataType create_and_check_datatype ()
 Create a DataType instance representing type T and perform a sanity check on its size. More...
 
template<typename T >
std::enable_if< std::is_same< std::size_t, T >::value >::type access_with_conversion (const T *&data, typename std::vector< T > &, const std::size_t, const std::vector< std::size_t > &element_ids)
 
template<typename T >
std::enable_if<!std::is_same< std::size_t, T >::value >::type access_with_conversion (const T *&data, typename std::vector< T > &raw_elements, const std::size_t length, const std::vector< std::size_t > &element_ids)
 

Typedef Documentation

◆ AttributeCreateProps

◆ DataSetAccessProps

◆ DataSetCreateProps

◆ DataTransferProps

◆ DataTypeAccessProps

◆ DataTypeCreateProps

◆ FileAccessProps

◆ FileCreateProps

◆ GroupAccessProps

◆ GroupCreateProps

◆ LinkAccessProps

◆ LinkCreateProps

◆ ObjectCopyProps

◆ ObjectCreateProps

◆ StringCreateProps

◆ unqualified_t

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

Enumeration Type Documentation

◆ DataTypeClass

Enum of Fundamental data classes.

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

◆ LinkType

enum HighFive::LinkType
strong

The possible types of group entries (link concept)

Enumerator
Hard 
Soft 
External 
Other 

◆ ObjectType

enum HighFive::ObjectType
strong

Enum of the types of objects (H5O api)

Enumerator
File 
Group 
UserDataType 
DataSpace 
Dataset 
Attribute 
Other 

◆ PropertyType

enum HighFive::PropertyType : int
strong

Types of property lists.

Enumerator
OBJECT_CREATE 
FILE_CREATE 
FILE_ACCESS 
DATASET_CREATE 
DATASET_ACCESS 
DATASET_XFER 
GROUP_CREATE 
GROUP_ACCESS 
DATATYPE_CREATE 
DATATYPE_ACCESS 
STRING_CREATE 
ATTRIBUTE_CREATE 
OBJECT_COPY 
LINK_CREATE 
LINK_ACCESS 

Function Documentation

◆ access_with_conversion() [1/2]

template<typename T >
std::enable_if<std::is_same<std::size_t, T>::value>::type HighFive::access_with_conversion ( const T *&  data,
typename std::vector< T > &  ,
const std::size_t  ,
const std::vector< std::size_t > &  element_ids 
)

◆ access_with_conversion() [2/2]

template<typename T >
std::enable_if<!std::is_same<std::size_t, T>::value>::type HighFive::access_with_conversion ( const T *&  data,
typename std::vector< T > &  raw_elements,
const std::size_t  length,
const std::vector< std::size_t > &  element_ids 
)

◆ 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.

◆ find_first_atomic_member_size()

size_t HighFive::find_first_atomic_member_size ( hid_t  hid)
inline