diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 000000000..e69de29bb diff --git a/_c_h_a_n_g_e_l_o_g_8md.html b/_c_h_a_n_g_e_l_o_g_8md.html new file mode 100644 index 000000000..38c063c3c --- /dev/null +++ b/_c_h_a_n_g_e_l_o_g_8md.html @@ -0,0 +1,109 @@ + + +
+ + + + +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
namespace | HighFive::deprecated |
+Macros | |
#define | H5_DEPRECATED(msg) |
#define | H5_DEPRECATED_USING(msg) |
#define H5_DEPRECATED | +( | +msg | ) | ++ |
#define H5_DEPRECATED_USING | +( | +msg | ) | ++ |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Classes | |
class | HighFive::AnnotateTraits< Derivate > |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <string>
#include <vector>
#include <H5Apublic.h>
#include <H5Ppublic.h>
#include "H5Attribute_misc.hpp"
#include "H5Iterables_misc.hpp"
#include "h5a_wrapper.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <vector>
#include <H5Apublic.h>
#include "H5DataType.hpp"
#include "H5Object.hpp"
#include "bits/H5Friends.hpp"
#include "bits/H5Path_traits.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::Attribute |
Class representing an Attribute of a DataSet or Group. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <algorithm>
#include <functional>
#include <numeric>
#include <sstream>
#include <string>
#include <H5Ppublic.h>
#include "../H5DataSpace.hpp"
#include "H5Converter_misc.hpp"
#include "H5ReadWrite_misc.hpp"
#include "H5Utils.hpp"
#include "h5a_wrapper.hpp"
#include "h5d_wrapper.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <vector>
#include "H5DataSpace.hpp"
#include "H5DataType.hpp"
#include "H5Object.hpp"
#include "bits/H5_definitions.hpp"
#include "bits/H5Annotate_traits.hpp"
#include "bits/H5Slice_traits.hpp"
#include "bits/H5Path_traits.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::DataSet |
Class representing a dataset. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <algorithm>
#include <functional>
#include <numeric>
#include <sstream>
#include <string>
#include <H5Ppublic.h>
#include "h5d_wrapper.hpp"
#include "H5Utils.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <vector>
#include <array>
#include <cstdint>
#include <type_traits>
#include <initializer_list>
#include "H5Object.hpp"
#include "bits/H5_definitions.hpp"
#include "bits/H5Dataspace_misc.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::DataSpace |
Class representing the space (dimensions) of a DataSet. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <type_traits>
#include <vector>
#include <H5Tpublic.h>
#include "H5Object.hpp"
#include "bits/H5Utils.hpp"
#include "bits/string_padding.hpp"
#include "H5PropertyList.hpp"
#include "bits/h5_wrapper.hpp"
#include "bits/h5t_wrapper.hpp"
#include "bits/H5DataType_misc.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::DataType |
HDF5 Data Type. More... | |
class | HighFive::StringType |
class | HighFive::FixedLengthStringType |
class | HighFive::VariableLengthStringType |
class | HighFive::AtomicType< T > |
create an HDF5 DataType from a C++ type More... | |
class | HighFive::CompoundType |
Create a compound HDF5 datatype. More... | |
struct | HighFive::CompoundType::member_def |
Use for defining a sub-type of compound type. More... | |
class | HighFive::EnumType< T > |
Create a enum HDF5 datatype. More... | |
struct | HighFive::EnumType< T >::member_def |
Use for defining a member of enum type. More... | |
class | HighFive::deprecated::FixedLenStringArray< N > |
A structure representing a set of fixed-length strings. More... | |
+Namespaces | |
namespace | HighFive |
namespace | HighFive::deprecated |
+Macros | |
#define | HIGHFIVE_REGISTER_TYPE(type, function) |
Macro to extend datatype of HighFive. | |
+Enumerations | |
enum class | HighFive::DataTypeClass { + HighFive::Time = 1 << 1 +, HighFive::Integer = 1 << 2 +, HighFive::Float = 1 << 3 +, HighFive::String = 1 << 4 +, + HighFive::BitField = 1 << 5 +, HighFive::Opaque = 1 << 6 +, HighFive::Compound = 1 << 7 +, HighFive::Reference = 1 << 8 +, + HighFive::Enum = 1 << 9 +, HighFive::VarLen = 1 << 10 +, HighFive::Array = 1 << 11 +, HighFive::Invalid = 0 + + } |
Enum of Fundamental data classes. More... | |
enum class | HighFive::CharacterSet : std::underlying_type< H5T_cset_t >::type { HighFive::Ascii = H5T_CSET_ASCII +, HighFive::Utf8 = H5T_CSET_UTF8 + } |
+Functions | |
DataTypeClass | HighFive::operator| (DataTypeClass lhs, DataTypeClass rhs) |
DataTypeClass | HighFive::operator& (DataTypeClass lhs, DataTypeClass rhs) |
template<typename T > | |
DataType | HighFive::create_datatype () |
Create a DataType instance representing type T. | |
template<typename T > | |
DataType | HighFive::create_and_check_datatype () |
Create a DataType instance representing type T and perform a sanity check on its size. | |
#define HIGHFIVE_REGISTER_TYPE | +( | +type, | +|
+ | + | function ) | +
Macro to extend datatype of HighFive.
+This macro has to be called outside of any namespace.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <string>
#include <complex>
#include <cstring>
#include <H5Ppublic.h>
#include "H5Inspector_misc.hpp"
#include "h5t_wrapper.hpp"
#include "h5i_wrapper.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::AtomicType< char[StrLen]> |
class | HighFive::AtomicType< deprecated::FixedLenStringArray< StrLen > > |
class | HighFive::AtomicType< std::complex< T > > |
+Namespaces | |
namespace | HighFive |
namespace | HighFive::deprecated |
+Macros | |
#define | _H5_STRUCT_PADDING(current_size, member_size) |
+Functions | |
EnumType< details::Boolean > | HighFive::create_enum_boolean () |
size_t | HighFive::find_first_atomic_member_size (hid_t hid) |
template<typename T > | |
DataType | HighFive::create_datatype () |
Create a DataType instance representing type T. | |
template<typename T > | |
DataType | HighFive::create_and_check_datatype () |
Create a DataType instance representing type T and perform a sanity check on its size. | |
template<> | |
DataType | HighFive::create_datatype< bool > () |
#define _H5_STRUCT_PADDING | +( | +current_size, | +|
+ | + | member_size ) | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <array>
#include <initializer_list>
#include <vector>
#include <numeric>
#include <H5Spublic.h>
#include "H5Utils.hpp"
#include "H5Converter_misc.hpp"
#include "h5s_wrapper.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <string>
#include <vector>
#include <xtensor/xarray.hpp>
#include <xtensor/xtensor.hpp>
#include <Eigen/Eigen>
#include <opencv2/opencv.hpp>
#include "H5File.hpp"
#include "h5easy_bits/H5Easy_Eigen.hpp"
#include "h5easy_bits/H5Easy_misc.hpp"
#include "h5easy_bits/H5Easy_opencv.hpp"
#include "h5easy_bits/H5Easy_public.hpp"
#include "h5easy_bits/H5Easy_scalar.hpp"
#include "h5easy_bits/H5Easy_vector.hpp"
#include "h5easy_bits/H5Easy_xtensor.hpp"
Go to the source code of this file.
++Classes | |
class | H5Easy::Compression |
Signal to set compression level for written DataSets. More... | |
class | H5Easy::DumpOptions |
Define options for dumping data. More... | |
+Namespaces | |
namespace | H5Easy |
Read/dump DataSets or Attribute using a minimalistic syntax. To this end, the functions are templated, and accept: | |
+Enumerations | |
enum class | H5Easy::DumpMode { H5Easy::Create = 0 +, H5Easy::Overwrite = 1 + } |
Write mode for DataSets. More... | |
enum class | H5Easy::Flush { H5Easy::False = 0 +, H5Easy::True = 1 + } |
Signal to enable/disable automatic flushing after write operations. More... | |
+Functions | |
size_t | H5Easy::getSize (const File &file, const std::string &path) |
Get the size of an existing DataSet in an open HDF5 file. | |
std::vector< size_t > | H5Easy::getShape (const File &file, const std::string &path) |
Get the shape of an existing DataSet in an readable file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, DumpMode mode=DumpMode::Create) |
Write object (templated) to a (new) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const DumpOptions &options) |
Write object (templated) to a (new) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const std::vector< size_t > &idx) |
Write a scalar to a (new, extendible) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const std::initializer_list< size_t > &idx) |
Write a scalar to a (new, extendable) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const std::vector< size_t > &idx, const DumpOptions &options) |
Write a scalar to a (new, extendible) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const std::initializer_list< size_t > &idx, const DumpOptions &options) |
Write a scalar to a (new, extendible) DataSet in an open HDF5 file. | |
template<class T > | |
T | H5Easy::load (const File &file, const std::string &path, const std::vector< size_t > &idx) |
Load entry {i, j, ...} from a DataSet in an open HDF5 file to a scalar. | |
template<class T > | |
T | H5Easy::load (const File &file, const std::string &path) |
Load a DataSet in an open HDF5 file to an object (templated). | |
template<class T > | |
Attribute | H5Easy::dumpAttribute (File &file, const std::string &path, const std::string &key, const T &data, DumpMode mode=DumpMode::Create) |
Write object (templated) to a (new) Attribute in an open HDF5 file. | |
template<class T > | |
Attribute | H5Easy::dumpAttribute (File &file, const std::string &path, const std::string &key, const T &data, const DumpOptions &options) |
Write object (templated) to a (new) Attribute in an open HDF5 file. | |
template<class T > | |
T | H5Easy::loadAttribute (const File &file, const std::string &path, const std::string &key) |
Load a Attribute in an open HDF5 file to an object (templated). | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | H5Easy |
Read/dump DataSets or Attribute using a minimalistic syntax. To this end, the functions are templated, and accept: | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include "../H5Easy.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | H5Easy |
Read/dump DataSets or Attribute using a minimalistic syntax. To this end, the functions are templated, and accept: | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | H5Easy |
Read/dump DataSets or Attribute using a minimalistic syntax. To this end, the functions are templated, and accept: | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include "../H5Easy.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | H5Easy |
Read/dump DataSets or Attribute using a minimalistic syntax. To this end, the functions are templated, and accept: | |
+Functions | |
size_t | H5Easy::getSize (const File &file, const std::string &path) |
Get the size of an existing DataSet in an open HDF5 file. | |
std::vector< size_t > | H5Easy::getShape (const File &file, const std::string &path) |
Get the shape of an existing DataSet in an readable file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const DumpOptions &options) |
Write object (templated) to a (new) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, DumpMode mode=DumpMode::Create) |
Write object (templated) to a (new) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const std::vector< size_t > &idx, const DumpOptions &options) |
Write a scalar to a (new, extendible) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const std::initializer_list< size_t > &idx, const DumpOptions &options) |
Write a scalar to a (new, extendible) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const std::vector< size_t > &idx) |
Write a scalar to a (new, extendible) DataSet in an open HDF5 file. | |
template<class T > | |
DataSet | H5Easy::dump (File &file, const std::string &path, const T &data, const std::initializer_list< size_t > &idx) |
Write a scalar to a (new, extendable) DataSet in an open HDF5 file. | |
template<class T > | |
T | H5Easy::load (const File &file, const std::string &path, const std::vector< size_t > &idx) |
Load entry {i, j, ...} from a DataSet in an open HDF5 file to a scalar. | |
template<class T > | |
T | H5Easy::load (const File &file, const std::string &path) |
Load a DataSet in an open HDF5 file to an object (templated). | |
template<class T > | |
Attribute | H5Easy::dumpAttribute (File &file, const std::string &path, const std::string &key, const T &data, DumpMode mode=DumpMode::Create) |
Write object (templated) to a (new) Attribute in an open HDF5 file. | |
template<class T > | |
Attribute | H5Easy::dumpAttribute (File &file, const std::string &path, const std::string &key, const T &data, const DumpOptions &options) |
Write object (templated) to a (new) Attribute in an open HDF5 file. | |
template<class T > | |
T | H5Easy::loadAttribute (const File &file, const std::string &path, const std::string &key) |
Load a Attribute in an open HDF5 file to an object (templated). | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | H5Easy |
Read/dump DataSets or Attribute using a minimalistic syntax. To this end, the functions are templated, and accept: | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | H5Easy |
Read/dump DataSets or Attribute using a minimalistic syntax. To this end, the functions are templated, and accept: | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | H5Easy |
Read/dump DataSets or Attribute using a minimalistic syntax. To this end, the functions are templated, and accept: | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <memory>
#include <stdexcept>
#include <string>
#include <H5Ipublic.h>
#include "bits/H5Exception_misc.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::Exception |
Basic HighFive Exception class. More... | |
class | HighFive::ObjectException |
Exception specific to HighFive Object interface. More... | |
class | HighFive::DataTypeException |
Exception specific to HighFive DataType interface. More... | |
class | HighFive::FileException |
Exception specific to HighFive File interface. More... | |
class | HighFive::DataSpaceException |
Exception specific to HighFive DataSpace interface. More... | |
class | HighFive::AttributeException |
Exception specific to HighFive Attribute interface. More... | |
class | HighFive::DataSetException |
Exception specific to HighFive DataSet interface. More... | |
class | HighFive::GroupException |
Exception specific to HighFive Group interface. More... | |
class | HighFive::PropertyException |
Exception specific to HighFive Property interface. More... | |
class | HighFive::ReferenceException |
Exception specific to HighFive Reference interface. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Classes | |
struct | HighFive::HDF5ErrMapper |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <string>
#include "H5FileDriver.hpp"
#include "H5Object.hpp"
#include "H5PropertyList.hpp"
#include "bits/H5Annotate_traits.hpp"
#include "bits/H5Node_traits.hpp"
#include "bits/H5Annotate_traits_misc.hpp"
#include "bits/H5File_misc.hpp"
#include "bits/H5Node_traits_misc.hpp"
#include "bits/H5Path_traits_misc.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::File |
File class. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <string>
#include <H5Fpublic.h>
#include "../H5Utility.hpp"
#include "H5Utils.hpp"
#include "h5f_wrapper.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include "H5PropertyList.hpp"
#include "bits/H5_definitions.hpp"
#include "bits/H5FileDriver_misc.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::FileDriver |
file driver base concept More... | |
class | HighFive::MPIOFileDriver |
MPIIO Driver for Parallel HDF5. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Gpublic.h>
#include "H5Object.hpp"
#include "bits/H5Friends.hpp"
#include "bits/H5_definitions.hpp"
#include "bits/H5Annotate_traits.hpp"
#include "bits/H5Node_traits.hpp"
#include "bits/H5Path_traits.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::Group |
Represents an hdf5 group. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <cstddef>
#include <numeric>
#include <functional>
#include <vector>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+Typedefs | |
template<typename T > | |
using | HighFive::unqualified_t = typename std::remove_const<typename std::remove_reference<T>::type>::type |
+Functions | |
size_t | HighFive::compute_total_size (const std::vector< size_t > &dims) |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <type_traits>
#include <cstring>
#include <cassert>
#include <vector>
#include <array>
#include <string>
#include <numeric>
#include "../H5Reference.hpp"
#include "string_padding.hpp"
#include "H5Inspector_decl.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <exception>
#include <string>
#include <vector>
#include <H5Ipublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <string>
#include "../H5PropertyList.hpp"
#include "H5_definitions.hpp"
#include "H5Converter_misc.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::NodeTraits< Derivate > |
NodeTraits: Base class for Group and File. More... | |
+Namespaces | |
namespace | HighFive |
+Enumerations | |
enum class | HighFive::IndexType : std::underlying_type< H5_index_t >::type { HighFive::NAME = H5_INDEX_NAME +, HighFive::CRT_ORDER = H5_INDEX_CRT_ORDER + } |
enum class | HighFive::LinkType { HighFive::Hard +, HighFive::Soft +, HighFive::External +, HighFive::Other + } |
The possible types of group entries (link concept) More... | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <string>
#include <vector>
#include <H5Apublic.h>
#include <H5Fpublic.h>
#include <H5Ppublic.h>
#include <H5Tpublic.h>
#include "../H5DataSet.hpp"
#include "../H5Group.hpp"
#include "../H5Selection.hpp"
#include "../H5Utility.hpp"
#include "H5DataSet_misc.hpp"
#include "H5Iterables_misc.hpp"
#include "H5Selection_misc.hpp"
#include "H5Slice_traits_misc.hpp"
#include "h5l_wrapper.hpp"
#include "h5g_wrapper.hpp"
#include "h5o_wrapper.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <ctime>
#include <H5Ipublic.h>
#include <H5Opublic.h>
#include "bits/H5_definitions.hpp"
#include "bits/H5Friends.hpp"
#include "bits/H5Object_misc.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::Object |
class | HighFive::ObjectInfo |
A class for accessing hdf5 objects info. More... | |
+Namespaces | |
namespace | HighFive |
+Enumerations | |
enum class | HighFive::ObjectType { + HighFive::File +, HighFive::Group +, HighFive::UserDataType +, HighFive::DataSpace +, + HighFive::Dataset +, HighFive::Attribute +, HighFive::Other + + } |
Enum of the types of objects (H5O api) More... | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <iostream>
#include "../H5Exception.hpp"
#include "../H5Utility.hpp"
#include "h5i_wrapper.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include "H5_definitions.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::PathTraits< Derivate > |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <vector>
#include <H5Ppublic.h>
#include <H5FDmpi.h>
#include "H5Exception.hpp"
#include "H5Object.hpp"
#include "bits/H5PropertyList_misc.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::PropertyListBase |
Base Class for Property lists, providing global default. More... | |
class | HighFive::PropertyList< T > |
HDF5 property Lists. More... | |
class | HighFive::RawPropertyList< T > |
class | HighFive::MPIOFileAccess |
Configure MPI access for the file. More... | |
class | HighFive::FileVersionBounds |
Configure the version bounds for the file. More... | |
class | HighFive::MetadataBlockSize |
Configure the metadata block size to use writing to files. More... | |
class | HighFive::EstimatedLinkInfo |
Set hints as to how many links to expect and their average length. More... | |
class | HighFive::Chunking |
class | HighFive::Deflate |
class | HighFive::Szip |
class | HighFive::Shuffle |
class | HighFive::AllocationTime |
When are datasets allocated? More... | |
class | HighFive::Caching |
class | HighFive::CreateIntermediateGroup |
class | HighFive::UseCollectiveIO |
class | HighFive::MpioNoCollectiveCause |
The cause for non-collective I/O. More... | |
struct | HighFive::CreationOrder |
class | HighFive::LinkCreationOrder |
Track and index creation order time. More... | |
class | HighFive::AttributePhaseChange |
Set threshold for attribute storage. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include "h5p_wrapper.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <string>
#include <vector>
#include <H5Ipublic.h>
#include <H5Rpublic.h>
#include "bits/H5_definitions.hpp"
#include "bits/H5Reference_misc.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::Reference |
An HDF5 (object) reference type. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <string>
#include <H5Ppublic.h>
#include "H5Utils.hpp"
#include "../H5Object.hpp"
#include "h5r_wrapper.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include "H5DataSet.hpp"
#include "H5DataSpace.hpp"
#include "bits/H5Slice_traits.hpp"
#include "bits/H5Friends.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::Selection |
Selection: represent a view on a slice/part of a dataset. More... | |
+Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <cstdlib>
#include <vector>
#include "H5_definitions.hpp"
#include "H5Utils.hpp"
#include "../H5PropertyList.hpp"
#include "h5s_wrapper.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::ElementSet |
struct | HighFive::RegularHyperSlab |
class | HighFive::HyperSlab |
class | HighFive::SliceTraits< Derivate > |
+Namespaces | |
namespace | HighFive |
+Functions | |
std::vector< hsize_t > | HighFive::toHDF5SizeVector (const std::vector< size_t > &from) |
std::vector< size_t > | HighFive::toSTLSizeVector (const std::vector< hsize_t > &from) |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <algorithm>
#include <cassert>
#include <functional>
#include <numeric>
#include <sstream>
#include <string>
#include "h5d_wrapper.hpp"
#include "h5s_wrapper.hpp"
#include "H5ReadWrite_misc.hpp"
#include "H5Converter_misc.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <functional>
#include <string>
#include <iostream>
#include "bits/h5e_wrapper.hpp"
#include "bits/H5Friends.hpp"
Go to the source code of this file.
++Classes | |
class | HighFive::SilenceHDF5 |
Utility class to disable HDF5 stack printing inside a scope. More... | |
class | HighFive::Logger |
A logger with supporting basic functionality. More... | |
+Namespaces | |
namespace | HighFive |
+Macros | |
#define | HIGHFIVE_LOG_LEVEL_DEBUG 10 |
#define | HIGHFIVE_LOG_LEVEL_INFO 20 |
#define | HIGHFIVE_LOG_LEVEL_WARN 30 |
#define | HIGHFIVE_LOG_LEVEL_ERROR 40 |
#define | HIGHFIVE_LOG_LEVEL HIGHFIVE_LOG_LEVEL_WARN |
#define | HIGHFIVE_LOG_DEBUG(message) ::HighFive::detail::log(::HighFive::LogSeverity::Debug, (message), __FILE__, __LINE__); |
#define | HIGHFIVE_LOG_DEBUG_IF(cond, message) |
#define | HIGHFIVE_LOG_INFO(message) ::HighFive::detail::log(::HighFive::LogSeverity::Info, (message), __FILE__, __LINE__); |
#define | HIGHFIVE_LOG_INFO_IF(cond, message) |
#define | HIGHFIVE_LOG_WARN(message) ::HighFive::detail::log(::HighFive::LogSeverity::Warn, (message), __FILE__, __LINE__); |
#define | HIGHFIVE_LOG_WARN_IF(cond, message) |
#define | HIGHFIVE_LOG_ERROR(message) ::HighFive::detail::log(::HighFive::LogSeverity::Error, (message), __FILE__, __LINE__); |
#define | HIGHFIVE_LOG_ERROR_IF(cond, message) |
+Enumerations | |
enum class | HighFive::LogSeverity { HighFive::Debug = HIGHFIVE_LOG_LEVEL_DEBUG +, HighFive::Info = HIGHFIVE_LOG_LEVEL_INFO +, HighFive::Warn = HIGHFIVE_LOG_LEVEL_WARN +, HighFive::Error = HIGHFIVE_LOG_LEVEL_ERROR + } |
+Functions | |
std::string | HighFive::to_string (LogSeverity severity) |
void | HighFive::default_logging_callback (LogSeverity severity, const std::string &message, const std::string &file, int line) |
Logger & | HighFive::get_global_logger () |
Obtain a reference to the logger used by HighFive. | |
void | HighFive::register_logging_callback (Logger::callback_type cb) |
Sets the callback that's used by the logger. | |
#define HIGHFIVE_LOG_DEBUG | +( | +message | ) | +::HighFive::detail::log(::HighFive::LogSeverity::Debug, (message), __FILE__, __LINE__); | +
#define HIGHFIVE_LOG_DEBUG_IF | +( | +cond, | +|
+ | + | message ) | +
#define HIGHFIVE_LOG_ERROR | +( | +message | ) | +::HighFive::detail::log(::HighFive::LogSeverity::Error, (message), __FILE__, __LINE__); | +
#define HIGHFIVE_LOG_ERROR_IF | +( | +cond, | +|
+ | + | message ) | +
#define HIGHFIVE_LOG_INFO | +( | +message | ) | +::HighFive::detail::log(::HighFive::LogSeverity::Info, (message), __FILE__, __LINE__); | +
#define HIGHFIVE_LOG_INFO_IF | +( | +cond, | +|
+ | + | message ) | +
#define HIGHFIVE_LOG_LEVEL HIGHFIVE_LOG_LEVEL_WARN | +
#define HIGHFIVE_LOG_LEVEL_DEBUG 10 | +
#define HIGHFIVE_LOG_LEVEL_ERROR 40 | +
#define HIGHFIVE_LOG_LEVEL_INFO 20 | +
#define HIGHFIVE_LOG_LEVEL_WARN 30 | +
#define HIGHFIVE_LOG_WARN | +( | +message | ) | +::HighFive::detail::log(::HighFive::LogSeverity::Warn, (message), __FILE__, __LINE__); | +
#define HIGHFIVE_LOG_WARN_IF | +( | +cond, | +|
+ | + | message ) | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <algorithm>
#include <array>
#include <cstddef>
#include <exception>
#include <string>
#include <type_traits>
#include <vector>
#include <sstream>
#include <H5public.h>
#include "../H5Exception.hpp"
#include "H5Friends.hpp"
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
namespace | HighFive::deprecated |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Macros | |
#define | HIGHFIVE_VERSION_MAJOR 2 |
#define | HIGHFIVE_VERSION_MINOR 9 |
#define | HIGHFIVE_VERSION_PATCH 0 |
#define | HIGHFIVE_VERSION 2.9.0 |
Concatenated representation of the HighFive version. | |
#define | HIGHFIVE_VERSION_STRING "2.9.0" |
String representation of the HighFive version. | |
#define HIGHFIVE_VERSION 2.9.0 | +
Concatenated representation of the HighFive version.
+HIGHFIVE_VERSION
by itself isn't valid C/C++.However, it can be stringified with two layers of macros, e.g.,
#define HIGHFIVE_VERSION_MAJOR 2 | +
#define HIGHFIVE_VERSION_MINOR 9 | +
#define HIGHFIVE_VERSION_PATCH 0 | +
#define HIGHFIVE_VERSION_STRING "2.9.0" | +
String representation of the HighFive version.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
▼NH5Easy | Read/dump DataSets or Attribute using a minimalistic syntax. To this end, the functions are templated, and accept: |
CCompression | Signal to set compression level for written DataSets |
CDumpOptions | Define options for dumping data |
▼NHighFive | |
▼Ndeprecated | |
CFixedLenStringArray | A structure representing a set of fixed-length strings |
CAllocationTime | When are datasets allocated? |
CAnnotateTraits | |
CAtomicType | Create an HDF5 DataType from a C++ type |
CAtomicType< char[StrLen]> | |
CAtomicType< deprecated::FixedLenStringArray< StrLen > > | |
CAtomicType< std::complex< T > > | |
CAttribute | Class representing an Attribute of a DataSet or Group |
CAttributeException | Exception specific to HighFive Attribute interface |
CAttributePhaseChange | Set threshold for attribute storage |
CCaching | |
CChunking | |
▼CCompoundType | Create a compound HDF5 datatype |
Cmember_def | Use for defining a sub-type of compound type |
CCreateIntermediateGroup | |
CCreationOrder | |
CDataSet | Class representing a dataset |
CDataSetException | Exception specific to HighFive DataSet interface |
CDataSpace | Class representing the space (dimensions) of a DataSet |
CDataSpaceException | Exception specific to HighFive DataSpace interface |
CDataType | HDF5 Data Type |
CDataTypeException | Exception specific to HighFive DataType interface |
CDeflate | |
CElementSet | |
▼CEnumType | Create a enum HDF5 datatype |
Cmember_def | Use for defining a member of enum type |
CEstimatedLinkInfo | Set hints as to how many links to expect and their average length |
CException | Basic HighFive Exception class |
CFile | File class |
CFileDriver | File driver base concept |
CFileException | Exception specific to HighFive File interface |
CFileVersionBounds | Configure the version bounds for the file |
CFixedLengthStringType | |
CGroup | Represents an hdf5 group |
CGroupException | Exception specific to HighFive Group interface |
CHDF5ErrMapper | |
CHyperSlab | |
CLinkCreationOrder | Track and index creation order time |
CLogger | A logger with supporting basic functionality |
CMetadataBlockSize | Configure the metadata block size to use writing to files |
CMPIOFileAccess | Configure MPI access for the file |
CMPIOFileDriver | MPIIO Driver for Parallel HDF5 |
CMpioNoCollectiveCause | The cause for non-collective I/O |
CNodeTraits | NodeTraits: Base class for Group and File |
CObject | |
CObjectException | Exception specific to HighFive Object interface |
CObjectInfo | A class for accessing hdf5 objects info |
CPathTraits | |
CPropertyException | Exception specific to HighFive Property interface |
CPropertyList | HDF5 property Lists |
CPropertyListBase | Base Class for Property lists, providing global default |
CRawPropertyList | |
CReference | An HDF5 (object) reference type |
CReferenceException | Exception specific to HighFive Reference interface |
CRegularHyperSlab | |
CSelection | Selection: represent a view on a slice/part of a dataset |
CShuffle | |
CSilenceHDF5 | Utility class to disable HDF5 stack printing inside a scope |
CSliceTraits | |
CStringType | |
CSzip | |
CUseCollectiveIO | |
CVariableLengthStringType | |
CPropertyInterface | HDF5 file property object |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include "bits/H5Inspector_decl.hpp"
#include "H5Exception.hpp"
#include <boost/multi_array.hpp>
#include <boost/numeric/ublas/matrix.hpp>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for H5Easy::Compression, including all inherited members.
+Compression(bool enable=true) | H5Easy::Compression | inlineexplicit |
Compression(T level) | H5Easy::Compression | inline |
get() const | H5Easy::Compression | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Signal to set compression level for written DataSets. + More...
+ +#include <H5Easy.hpp>
+Public Member Functions | |
Compression (bool enable=true) | |
Enable compression with the highest compression level (9). or disable compression (set compression level to 0). | |
template<class T > | |
Compression (T level) | |
Set compression level. | |
unsigned | get () const |
Return compression level. | |
Signal to set compression level for written DataSets.
+
+
|
+ +inlineexplicit | +
Enable compression with the highest compression level (9). or disable compression (set compression level to 0).
+enable | true to enable with highest compression level |
+
|
+ +inline | +
Set compression level.
+level | the compression level |
+
|
+ +inline | +
Return compression level.
+ +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for H5Easy::DumpOptions, including all inherited members.
+compress() const | H5Easy::DumpOptions | inline |
DumpOptions()=default | H5Easy::DumpOptions | |
DumpOptions(Args... args) | H5Easy::DumpOptions | inline |
flush() const | H5Easy::DumpOptions | inline |
getChunkSize() const | H5Easy::DumpOptions | inline |
getCompressionLevel() const | H5Easy::DumpOptions | inline |
isChunked() const | H5Easy::DumpOptions | inline |
overwrite() const | H5Easy::DumpOptions | inline |
set(DumpMode mode) | H5Easy::DumpOptions | inline |
set(Flush mode) | H5Easy::DumpOptions | inline |
set(const Compression &level) | H5Easy::DumpOptions | inline |
set(T arg, Args... args) | H5Easy::DumpOptions | inline |
setChunkSize(const std::vector< T > &shape) | H5Easy::DumpOptions | inline |
setChunkSize(std::initializer_list< size_t > shape) | H5Easy::DumpOptions | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Define options for dumping data. + More...
+ +#include <H5Easy.hpp>
+Public Member Functions | |
DumpOptions ()=default | |
Constructor: accept all default settings. | |
template<class... Args> | |
DumpOptions (Args... args) | |
Constructor: overwrite (some of the) defaults. | |
void | set (DumpMode mode) |
Overwrite H5Easy::DumpMode setting. | |
void | set (Flush mode) |
Overwrite H5Easy::Flush setting. | |
void | set (const Compression &level) |
Overwrite H5Easy::Compression setting. | |
template<class T , class... Args> | |
void | set (T arg, Args... args) |
Overwrite any setting(s). | |
template<class T > | |
void | setChunkSize (const std::vector< T > &shape) |
Set chunk-size. If the input is rank (size) zero, automatic chunking is enabled. | |
void | setChunkSize (std::initializer_list< size_t > shape) |
Set chunk-size. If the input is rank (size) zero, automatic chunking is enabled. | |
bool | overwrite () const |
Get overwrite-mode. | |
bool | flush () const |
Get flush-mode. | |
bool | compress () const |
Get compress-mode. | |
unsigned | getCompressionLevel () const |
Get compression level. | |
bool | isChunked () const |
Get chunking mode: true is manually set, false if chunk-size should be computed automatically. | |
std::vector< hsize_t > | getChunkSize () const |
Get chunk size. Use DumpOptions::getChunkSize to check if chunk-size should be automatically computed. | |
Define options for dumping data.
+By default:
+
|
+ +default | +
Constructor: accept all default settings.
+ +
+
|
+ +inline | +
Constructor: overwrite (some of the) defaults.
+args | any of DumpMode(), Flush(), Compression() in arbitrary number and order. |
+
|
+ +inline | +
Get compress-mode.
+
+
|
+ +inline | +
Get flush-mode.
+
+
|
+ +inline | +
Get chunk size. Use DumpOptions::getChunkSize to check if chunk-size should be automatically computed.
+ +
+
|
+ +inline | +
Get compression level.
+
+
|
+ +inline | +
Get chunking mode: true
is manually set, false
if chunk-size should be computed automatically.
+
|
+ +inline | +
Get overwrite-mode.
+
+
|
+ +inline | +
Overwrite H5Easy::Compression setting.
+level | Compression. |
+
|
+ +inline | +
Overwrite H5Easy::DumpMode setting.
+mode | DumpMode. |
+
|
+ +inline | +
Overwrite H5Easy::Flush setting.
+mode | Flush. |
+
|
+ +inline | +
Overwrite any setting(s).
+arg | any of DumpMode(), Flush(), Compression in arbitrary number and order. |
args | any of DumpMode(), Flush(), Compression in arbitrary number and order. |
+
|
+ +inline | +
Set chunk-size. If the input is rank (size) zero, automatic chunking is enabled.
+shape | Chunk size along each dimension. |
+
|
+ +inline | +
Set chunk-size. If the input is rank (size) zero, automatic chunking is enabled.
+shape | Chunk size along each dimension. |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::AllocationTime, including all inherited members.
+AllocationTime(H5D_alloc_time_t alloc_time) | HighFive::AllocationTime | inlineexplicit |
AllocationTime(const DataSetCreateProps &dcpl) | HighFive::AllocationTime | inlineexplicit |
getAllocationTime() | HighFive::AllocationTime | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
When are datasets allocated? + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
AllocationTime (H5D_alloc_time_t alloc_time) | |
AllocationTime (const DataSetCreateProps &dcpl) | |
H5D_alloc_time_t | getAllocationTime () |
When are datasets allocated?
+The precise time of when HDF5 requests space to store the dataset can be configured. Please, consider the upstream documentation for H5Pset_alloc_time
.
+
|
+ +inlineexplicit | +
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::AnnotateTraits< Derivate >, including all inherited members.
+createAttribute(const std::string &attribute_name, const DataSpace &space, const DataType &type) | HighFive::AnnotateTraits< Derivate > | inline |
createAttribute(const std::string &attribute_name, const DataSpace &space) | HighFive::AnnotateTraits< Derivate > | inline |
createAttribute(const std::string &attribute_name, const T &data) | HighFive::AnnotateTraits< Derivate > | inline |
deleteAttribute(const std::string &attribute_name) | HighFive::AnnotateTraits< Derivate > | inline |
getAttribute(const std::string &attribute_name) const | HighFive::AnnotateTraits< Derivate > | inline |
getNumberAttributes() const | HighFive::AnnotateTraits< Derivate > | inline |
hasAttribute(const std::string &attr_name) const | HighFive::AnnotateTraits< Derivate > | inline |
listAttributeNames() const | HighFive::AnnotateTraits< Derivate > | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Annotate_traits.hpp>
+Public Member Functions | |
Attribute | createAttribute (const std::string &attribute_name, const DataSpace &space, const DataType &type) |
create a new attribute with the name attribute_name | |
template<typename Type > | |
Attribute | createAttribute (const std::string &attribute_name, const DataSpace &space) |
createAttribute create a new attribute on the current dataset with size specified by space | |
template<typename T > | |
Attribute | createAttribute (const std::string &attribute_name, const T &data) |
createAttribute create a new attribute on the current dataset and write to it, inferring the DataSpace from data. | |
void | deleteAttribute (const std::string &attribute_name) |
deleteAttribute let you delete an attribute by its name. | |
Attribute | getAttribute (const std::string &attribute_name) const |
open an existing attribute with the name attribute_name | |
size_t | getNumberAttributes () const |
return the number of attributes of the node / group | |
std::vector< std::string > | listAttributeNames () const |
list all attribute name of the node / group | |
bool | hasAttribute (const std::string &attr_name) const |
checks an attribute exists | |
+
|
+ +inline | +
+
|
+ +inline | +
create a new attribute with the name attribute_name
+attribute_name | identifier of the attribute |
space | Associated DataSpace |
type |
+
|
+ +inline | +
createAttribute create a new attribute on the current dataset and write to it, inferring the DataSpace from data.
+attribute_name | identifier of the attribute |
data | Associated data to write, must support DataSpace::From, see DataSpace for more information |
+
|
+ +inline | +
deleteAttribute let you delete an attribute by its name.
+attribute_name | identifier of the attribute |
+
|
+ +inline | +
open an existing attribute with the name attribute_name
+attribute_name | identifier of the attribute |
+
|
+ +inline | +
return the number of attributes of the node / group
+
+
|
+ +inline | +
checks an attribute exists
+
+
|
+ +inline | +
list all attribute name of the node / group
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::AtomicType< T >, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
create an HDF5 DataType from a C++ type + More...
+ +#include <H5DataType.hpp>
+Public Types | |
using | basic_type = T |
+Public Member Functions | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
AtomicType () | |
Public Member Functions inherited from HighFive::DataType | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::DataType | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
create an HDF5 DataType from a C++ type
+Support only basic data type
+using HighFive::AtomicType< T >::basic_type = T | +
HighFive::AtomicType< T >::AtomicType | +( | +) | ++ |
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::AtomicType< char[StrLen]>, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5DataType_misc.hpp>
+Public Member Functions | |
AtomicType () | |
Public Member Functions inherited from HighFive::DataType | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::DataType | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::AtomicType< deprecated::FixedLenStringArray< StrLen > >, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5DataType_misc.hpp>
+Public Member Functions | |
AtomicType () | |
Public Member Functions inherited from HighFive::DataType | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::DataType | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::AtomicType< std::complex< T > >, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5DataType_misc.hpp>
+Public Member Functions | |
AtomicType () | |
Public Member Functions inherited from HighFive::DataType | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::DataType | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Attribute, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Class representing an Attribute of a DataSet or Group. + More...
+ +#include <H5Attribute.hpp>
+Public Member Functions | |
std::string | getName () const |
Get the name of the current Attribute. | |
size_t | getStorageSize () const |
The number of bytes required to store the attribute in the HDF5 file. | |
DataType | getDataType () const |
Get the DataType of the Attribute. | |
DataSpace | getSpace () const |
Get the DataSpace of the current Attribute. | |
DataSpace | getMemSpace () const |
Get the DataSpace of the current Attribute. | |
template<typename T > | |
T | read () const |
Get the value of the Attribute. | |
template<typename T > | |
void | read (T &array) const |
Get the value of the Attribute in a buffer. | |
template<typename T > | |
void | read_raw (T *array, const DataType &mem_datatype) const |
Read the attribute into a pre-allocated buffer. | |
template<typename T > | |
void | read_raw (T *array) const |
Read the attribute into a buffer. Behaves like Attribute::read(T*, const DataType&) const but additionally this overload deduces the memory datatype from T . | |
template<typename T > | |
void | write (const T &value) |
Write the value into the Attribute. | |
template<typename T > | |
void | write_raw (const T *buffer, const DataType &mem_datatype) |
Write from a raw pointer. | |
template<typename T > | |
void | write_raw (const T *buffer) |
Write from a raw pointer. | |
AttributeCreateProps | getCreatePropertyList () const |
The create property list used for this attribute. | |
Attribute ()=delete | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
Public Member Functions inherited from HighFive::PathTraits< Attribute > | |
PathTraits () | |
std::string | getPath () const |
return the path to the current object | |
File & | getFile () const noexcept |
Return a reference to the File object this object belongs. | |
+Static Public Attributes | |
static const ObjectType | type = ObjectType::Attribute |
+Protected Member Functions | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
Protected Attributes inherited from HighFive::PathTraits< Attribute > | |
std::shared_ptr< File > | _file_obj |
Class representing an Attribute of a DataSet or Group.
+
+
|
+ +delete | +
+
|
+ +inline | +
The create property list used for this attribute.
+Some of HDF5 properties/setting of an attribute are defined by a create property list. This method returns a copy of the create property list used during creation of the attribute.
+
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
Get the name of the current Attribute.
+
+
|
+ +inline | +
+
|
+ +inline | +
The number of bytes required to store the attribute in the HDF5 file.
+
+
|
+ +inlineprotected | +
+
|
+ +inlineprotected | +
+
|
+ +inlineexplicitprotected | +
+
|
+ +inlineprotectednoexcept | +
+
|
+ +inline | +
Get the value of the Attribute.
+
+
|
+ +inline | +
Get the value of the Attribute in a buffer.
+Read the attribute into an existing object. Only available for supported types T
. If array
has preallocated the correct amount of memory, then this routine should not trigger reallocation. Otherwise, if supported, the object will be resized.
An exception is raised if the numbers of dimension of the buffer and of the attribute are different.
+
+
|
+ +inline | +
Read the attribute into a buffer. Behaves like Attribute::read(T*, const DataType&) const but additionally this overload deduces the memory datatype from T
.
array | Pointer to the first byte of pre-allocated memory. |
+
|
+ +inline | +
Read the attribute into a pre-allocated buffer.
+array | A pointer to the first byte of sufficient pre-allocated memory. |
mem_datatype | The DataType of the array. |
H5Aread
. If possible prefer either Attribute::read() const or Attribute::read(T&) const.
+
|
+ +inline | +
Write the value into the Attribute.
+Write the value to the attribute. For supported types T
, this overload will write the value to the attribute. The datatype and dataspace are deduced automatically. However, since the attribute has already been created, the dimensions of value
must match those of the attribute.
+
|
+ +inline | +
Write from a raw pointer.
+Much like Attribute::write_raw(const T*, const DataType&). Additionally, this overload attempts to automatically deduce the datatype of the buffer. Note, that the file datatype is already set.
+buffer | Pointer to the first byte. |
+
|
+ +inline | +
Write from a raw pointer.
+Values that have been correctly arranged memory, can be written directly by passing a raw pointer.
+buffer | Pointer to the first byte of the value. |
mem_datatype | The DataType of the buffer. |
H5Awrite
. It's useful if you need full control. If possible prefer Attribute::write.
+
|
+ +static | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::AttributeException, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
AttributeException(const std::string &err_msg) | HighFive::AttributeException | inline |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
nextException() const | HighFive::Exception | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Exception specific to HighFive Attribute interface. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
AttributeException (const std::string &err_msg) | |
Public Member Functions inherited from HighFive::Exception | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Exception | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::AttributePhaseChange, including all inherited members.
+AttributePhaseChange(unsigned max_compact, unsigned min_dense) | HighFive::AttributePhaseChange | inline |
AttributePhaseChange(const GroupCreateProps &gcpl) | HighFive::AttributePhaseChange | inlineexplicit |
max_compact() const | HighFive::AttributePhaseChange | inline |
min_dense() const | HighFive::AttributePhaseChange | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Set threshold for attribute storage. + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
AttributePhaseChange (unsigned max_compact, unsigned min_dense) | |
Create the property from the threshold values. | |
AttributePhaseChange (const GroupCreateProps &gcpl) | |
Extract threshold values from property list. | |
unsigned | max_compact () const |
unsigned | min_dense () const |
Set threshold for attribute storage.
+HDF5 can store Attributes in the object header (compact) or in the B-tree (dense). This property sets the threshold when attributes are moved to one or the other storage format.
+Please refer to the upstream documentation of H5Pset_attr_phase_change
or Section 8 (Attributes) in the User Guide, in particular Subsection 8.5.
+
|
+ +inline | +
Create the property from the threshold values.
+When the number of attributes hits max_compact
the attributes are moved to dense storage, once the number drops to below min_dense
the attributes are moved to compact storage.
+
|
+ +inlineexplicit | +
Extract threshold values from property list.
+ +
+
|
+ +inline | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Caching, including all inherited members.
+Caching(const size_t numSlots, const size_t cacheSize, const double w0=static_cast< double >(H5D_CHUNK_CACHE_W0_DEFAULT)) | HighFive::Caching | inline |
Caching(const DataSetCreateProps &dcpl) | HighFive::Caching | inlineexplicit |
getCacheSize() const | HighFive::Caching | inline |
getNumSlots() const | HighFive::Caching | inline |
getW0() const | HighFive::Caching | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5PropertyList.hpp>
+Public Member Functions | |
Caching (const size_t numSlots, const size_t cacheSize, const double w0=static_cast< double >(H5D_CHUNK_CACHE_W0_DEFAULT)) | |
Caching (const DataSetCreateProps &dcpl) | |
size_t | getNumSlots () const |
size_t | getCacheSize () const |
double | getW0 () const |
Dataset access property to control chunk cache configuration. Do not confuse with the similar file access property for H5Pset_cache
+
+
|
+ +inline | +
https://support.hdfgroup.org/HDF5/doc/RM/H5P/H5Pset_chunk_cache.html for details.
+ +
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Chunking, including all inherited members.
+Chunking(const std::vector< hsize_t > &dims) | HighFive::Chunking | inlineexplicit |
Chunking(const std::initializer_list< hsize_t > &items) | HighFive::Chunking | inline |
Chunking(hsize_t item, Args... args) | HighFive::Chunking | inlineexplicit |
Chunking(DataSetCreateProps &plist, size_t max_dims=32) | HighFive::Chunking | inlineexplicit |
getDimensions() const noexcept | HighFive::Chunking | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5PropertyList.hpp>
+Public Member Functions | |
Chunking (const std::vector< hsize_t > &dims) | |
Chunking (const std::initializer_list< hsize_t > &items) | |
template<typename... Args> | |
Chunking (hsize_t item, Args... args) | |
Chunking (DataSetCreateProps &plist, size_t max_dims=32) | |
const std::vector< hsize_t > & | getDimensions () const noexcept |
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+
|
+ +inlineexplicit | +
+
|
+ +inlineexplicit | +
+
|
+ +inlinenoexcept | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::CompoundType, including all inherited members.
+_hid | HighFive::Object | protected |
asStringType() const | HighFive::DataType | inline |
commit(const Object &object, const std::string &name) const | HighFive::CompoundType | inline |
CompoundType(const CompoundType &other)=default | HighFive::CompoundType | |
CompoundType(const std::vector< member_def > &t_members, size_t size=0) | HighFive::CompoundType | inline |
CompoundType(std::vector< member_def > &&t_members, size_t size=0) | HighFive::CompoundType | inline |
CompoundType(const std::initializer_list< member_def > &t_members, size_t size=0) | HighFive::CompoundType | inline |
CompoundType(DataType &&type) | HighFive::CompoundType | inline |
empty() const noexcept | HighFive::DataType | inline |
getClass() const | HighFive::DataType | inline |
getCreatePropertyList() const | HighFive::DataType | inline |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getMembers() const noexcept | HighFive::CompoundType | inline |
getSize() const | HighFive::DataType | inline |
getType() const | HighFive::Object | inline |
isFixedLenStr() const | HighFive::DataType | inline |
isReference() const | HighFive::DataType | inline |
isValid() const noexcept | HighFive::Object | inline |
isVariableStr() const | HighFive::DataType | inline |
Object(Object &&other) noexcept | HighFive::DataType | inlineprotected |
Object() | HighFive::DataType | inlineprotected |
Object(const Object &other) | HighFive::DataType | inlineprotected |
Object(hid_t) | HighFive::DataType | inlineexplicitprotected |
operator!=(const DataType &other) const | HighFive::DataType | inline |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const DataType &other) const | HighFive::DataType | inline |
HighFive::Object::operator==(const Object &other) const noexcept | HighFive::Object | inline |
string() const | HighFive::DataType | inline |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Create a compound HDF5 datatype. + More...
+ +#include <H5DataType.hpp>
+Classes | |
struct | member_def |
Use for defining a sub-type of compound type. More... | |
+Public Member Functions | |
CompoundType (const CompoundType &other)=default | |
CompoundType (const std::vector< member_def > &t_members, size_t size=0) | |
Initializes a compound type from a vector of member definitions. | |
CompoundType (std::vector< member_def > &&t_members, size_t size=0) | |
CompoundType (const std::initializer_list< member_def > &t_members, size_t size=0) | |
CompoundType (DataType &&type) | |
Initializes a compound type from a DataType. | |
void | commit (const Object &object, const std::string &name) const |
Commit datatype into the given Object. | |
const std::vector< member_def > & | getMembers () const noexcept |
Get read access to the CompoundType members. | |
Public Member Functions inherited from HighFive::DataType | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::DataType | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
Create a compound HDF5 datatype.
+
+
|
+ +default | +
+
|
+ +inline | +
Initializes a compound type from a vector of member definitions.
+t_members | |
size |
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
Initializes a compound type from a DataType.
+type |
+
|
+ +inline | +
Commit datatype into the given Object.
+object | Location to commit object into |
name | Name to give the datatype |
+
|
+ +inlinenoexcept | +
Get read access to the CompoundType members.
+ +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::CreateIntermediateGroup, including all inherited members.
+CreateIntermediateGroup(bool create=true) | HighFive::CreateIntermediateGroup | inlineexplicit |
CreateIntermediateGroup(const ObjectCreateProps &ocpl) | HighFive::CreateIntermediateGroup | inlineexplicit |
CreateIntermediateGroup(const LinkCreateProps &lcpl) | HighFive::CreateIntermediateGroup | explicit |
fromPropertyList(hid_t hid) | HighFive::CreateIntermediateGroup | inlineprotected |
isSet() const | HighFive::CreateIntermediateGroup | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5PropertyList.hpp>
+Public Member Functions | |
CreateIntermediateGroup (bool create=true) | |
CreateIntermediateGroup (const ObjectCreateProps &ocpl) | |
CreateIntermediateGroup (const LinkCreateProps &lcpl) | |
bool | isSet () const |
+Protected Member Functions | |
void | fromPropertyList (hid_t hid) |
+
|
+ +inlineexplicit | +
+
|
+ +inlineexplicit | +
+
|
+ +explicit | +
+
|
+ +inlineprotected | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::DataSet, including all inherited members.
+_file_obj | HighFive::PathTraits< DataSet > | protected |
_hid | HighFive::Object | protected |
createAttribute(const std::string &attribute_name, const DataSpace &space, const DataType &type) | HighFive::AnnotateTraits< DataSet > | inline |
createAttribute(const std::string &attribute_name, const DataSpace &space) | HighFive::AnnotateTraits< DataSet > | inline |
createAttribute(const std::string &attribute_name, const T &data) | HighFive::AnnotateTraits< DataSet > | inline |
DataSet()=default | HighFive::DataSet | |
DataSet(Object &&o) noexcept | HighFive::DataSet | inlineprotected |
deleteAttribute(const std::string &attribute_name) | HighFive::AnnotateTraits< DataSet > | inline |
getAccessPropertyList() const | HighFive::DataSet | inline |
getAttribute(const std::string &attribute_name) const | HighFive::AnnotateTraits< DataSet > | inline |
getCreatePropertyList() const | HighFive::DataSet | inline |
getDataType() const | HighFive::DataSet | inline |
getDimensions() const | HighFive::DataSet | inline |
getElementCount() const | HighFive::DataSet | inline |
getFile() const noexcept | HighFive::PathTraits< DataSet > | inline |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getMemSpace() const | HighFive::DataSet | inline |
getNumberAttributes() const | HighFive::AnnotateTraits< DataSet > | inline |
getOffset() const | HighFive::DataSet | inline |
getPath() const | HighFive::PathTraits< DataSet > | inline |
getSpace() const | HighFive::DataSet | inline |
getStorageSize() const | HighFive::DataSet | inline |
getType() const | HighFive::Object | inline |
hasAttribute(const std::string &attr_name) const | HighFive::AnnotateTraits< DataSet > | inline |
isValid() const noexcept | HighFive::Object | inline |
listAttributeNames() const | HighFive::AnnotateTraits< DataSet > | inline |
NodeTraits | HighFive::DataSet | friend |
Object(Object &&other) noexcept | HighFive::DataSet | inlineprotected |
Object() | HighFive::DataSet | inlineprotected |
Object(const Object &other) | HighFive::DataSet | inlineprotected |
Object(hid_t) | HighFive::DataSet | inlineexplicitprotected |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const Object &other) const noexcept | HighFive::Object | inline |
PathTraits() | HighFive::PathTraits< DataSet > | inline |
read(const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< DataSet > | inline |
read(T &array, const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< DataSet > | inline |
read_raw(T *array, const DataType &dtype, const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< DataSet > | inline |
read_raw(T *array, const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< DataSet > | inline |
Reference | HighFive::DataSet | friend |
resize(const std::vector< size_t > &dims) | HighFive::DataSet | inline |
select(const HyperSlab &hyperslab) const | HighFive::SliceTraits< DataSet > | inline |
select(const HyperSlab &hyperslab, const DataSpace &memspace) const | HighFive::SliceTraits< DataSet > | inline |
select(const std::vector< size_t > &offset, const std::vector< size_t > &count, const std::vector< size_t > &stride={}, const std::vector< size_t > &block={}) const | HighFive::SliceTraits< DataSet > | inline |
select(const std::vector< size_t > &columns) const | HighFive::SliceTraits< DataSet > | inline |
select(const ElementSet &elements) const | HighFive::SliceTraits< DataSet > | inline |
type | HighFive::DataSet | static |
write(const T &buffer, const DataTransferProps &xfer_props=DataTransferProps()) | HighFive::SliceTraits< DataSet > | inline |
write_raw(const T *buffer, const DataType &mem_datatype, const DataTransferProps &xfer_props=DataTransferProps()) | HighFive::SliceTraits< DataSet > | inline |
write_raw(const T *buffer, const DataTransferProps &xfer_props=DataTransferProps()) | HighFive::SliceTraits< DataSet > | inline |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Class representing a dataset. + More...
+ +#include <H5DataSet.hpp>
+Public Member Functions | |
uint64_t | getStorageSize () const |
getStorageSize | |
uint64_t | getOffset () const |
getOffset | |
DataType | getDataType () const |
getDataType | |
DataSpace | getSpace () const |
getSpace | |
DataSpace | getMemSpace () const |
getMemSpace | |
void | resize (const std::vector< size_t > &dims) |
Change the size of the dataset. | |
std::vector< size_t > | getDimensions () const |
Get the dimensions of the whole DataSet. This is a shorthand for getSpace().getDimensions() | |
size_t | getElementCount () const |
Get the total number of elements in the current dataset. E.g. 2x2x2 matrix has size 8. This is a shorthand for getSpace().getTotalCount() | |
DataSetCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this dataset. | |
DataSetAccessProps | getAccessPropertyList () const |
Get the list of properties for accession of this dataset. | |
DataSet ()=default | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
Public Member Functions inherited from HighFive::SliceTraits< DataSet > | |
Selection | select (const HyperSlab &hyperslab) const |
Select an hyperslab in the current Slice/Dataset. | |
Selection | select (const HyperSlab &hyperslab, const DataSpace &memspace) const |
Select an hyperslab in the current Slice/Dataset. | |
Selection | select (const std::vector< size_t > &offset, const std::vector< size_t > &count, const std::vector< size_t > &stride={}, const std::vector< size_t > &block={}) const |
Select a region in the current Slice/Dataset of count points at offset separated by stride . If strides are not provided they will default to 1 in all dimensions. | |
Selection | select (const std::vector< size_t > &columns) const |
Select a set of columns in the last dimension of this dataset. | |
Selection | select (const ElementSet &elements) const |
Select a region in the current Slice/Dataset out of a list of elements. | |
T | read (const DataTransferProps &xfer_props=DataTransferProps()) const |
void | read (T &array, const DataTransferProps &xfer_props=DataTransferProps()) const |
void | read_raw (T *array, const DataType &dtype, const DataTransferProps &xfer_props=DataTransferProps()) const |
void | read_raw (T *array, const DataTransferProps &xfer_props=DataTransferProps()) const |
void | write (const T &buffer, const DataTransferProps &xfer_props=DataTransferProps()) |
void | write_raw (const T *buffer, const DataType &mem_datatype, const DataTransferProps &xfer_props=DataTransferProps()) |
void | write_raw (const T *buffer, const DataTransferProps &xfer_props=DataTransferProps()) |
Public Member Functions inherited from HighFive::AnnotateTraits< DataSet > | |
Attribute | createAttribute (const std::string &attribute_name, const DataSpace &space, const DataType &type) |
create a new attribute with the name attribute_name | |
Attribute | createAttribute (const std::string &attribute_name, const DataSpace &space) |
createAttribute create a new attribute on the current dataset with size specified by space | |
Attribute | createAttribute (const std::string &attribute_name, const T &data) |
createAttribute create a new attribute on the current dataset and write to it, inferring the DataSpace from data. | |
void | deleteAttribute (const std::string &attribute_name) |
deleteAttribute let you delete an attribute by its name. | |
Attribute | getAttribute (const std::string &attribute_name) const |
open an existing attribute with the name attribute_name | |
size_t | getNumberAttributes () const |
return the number of attributes of the node / group | |
std::vector< std::string > | listAttributeNames () const |
list all attribute name of the node / group | |
bool | hasAttribute (const std::string &attr_name) const |
checks an attribute exists | |
Public Member Functions inherited from HighFive::PathTraits< DataSet > | |
PathTraits () | |
std::string | getPath () const |
return the path to the current object | |
File & | getFile () const noexcept |
Return a reference to the File object this object belongs. | |
+Static Public Attributes | |
static const ObjectType | type = ObjectType::Dataset |
+Protected Member Functions | |
DataSet (Object &&o) noexcept | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
+Friends | |
class | Reference |
template<typename Derivate > | |
class | NodeTraits |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
Protected Attributes inherited from HighFive::PathTraits< DataSet > | |
std::shared_ptr< File > | _file_obj |
Class representing a dataset.
+
+
|
+ +default | +
+
|
+ +inlineprotectednoexcept | +
+
|
+ +inline | +
Get the list of properties for accession of this dataset.
+ +
+
|
+ +inline | +
Get the list of properties for creation of this dataset.
+ +
+
|
+ +inline | +
getDataType
+
+
|
+ +inline | +
Get the dimensions of the whole DataSet. This is a shorthand for getSpace().getDimensions()
+
+
|
+ +inline | +
Get the total number of elements in the current dataset. E.g. 2x2x2 matrix has size 8. This is a shorthand for getSpace().getTotalCount()
+
+
|
+ +inline | +
+
|
+ +inline | +
getOffset
+
+
|
+ +inline | +
getSpace
+
+
|
+ +inline | +
getStorageSize
+
+
|
+ +inlineprotected | +
+
|
+ +inlineprotected | +
+
|
+ +inlineexplicitprotected | +
+
|
+ +inlineprotectednoexcept | +
+
|
+ +inline | +
Change the size of the dataset.
+This requires that the dataset was created with chunking, and you would generally want to have set a larger maxdims setting
dims | New size of the dataset |
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +static | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::DataSetException, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
DataSetException(const std::string &err_msg) | HighFive::DataSetException | inline |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
nextException() const | HighFive::Exception | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Exception specific to HighFive DataSet interface. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
DataSetException (const std::string &err_msg) | |
Public Member Functions inherited from HighFive::Exception | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Exception | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::DataSpace, including all inherited members.
+_hid | HighFive::Object | protected |
Attribute | HighFive::DataSpace | friend |
clone() const | HighFive::DataSpace | inline |
DataSet | HighFive::DataSpace | friend |
DataSpace(const std::vector< size_t > &dims) | HighFive::DataSpace | inlineexplicit |
DataSpace(const std::array< size_t, N > &dims) | HighFive::DataSpace | inlineexplicit |
DataSpace(const std::initializer_list< size_t > &dims) | HighFive::DataSpace | inline |
DataSpace(size_t dim1, Args... dims) | HighFive::DataSpace | inlineexplicit |
DataSpace(const IT begin, const IT end) | HighFive::DataSpace | inline |
DataSpace(const std::vector< size_t > &dims, const std::vector< size_t > &maxdims) | HighFive::DataSpace | inlineexplicit |
DataSpace(DataspaceType space_type) | HighFive::DataSpace | inlineexplicit |
DataSpace()=default | HighFive::DataSpace | protected |
dataspace_null enum value | HighFive::DataSpace | |
dataspace_scalar enum value | HighFive::DataSpace | |
DataspaceType enum name | HighFive::DataSpace | |
File | HighFive::DataSpace | friend |
From(const T &value) | HighFive::DataSpace | inlinestatic |
FromCharArrayStrings(const char(&string_array)[N][Width]) | HighFive::DataSpace | inlinestatic |
getDimensions() const | HighFive::DataSpace | inline |
getElementCount() const | HighFive::DataSpace | inline |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getMaxDimensions() const | HighFive::DataSpace | inline |
getNumberDimensions() const | HighFive::DataSpace | inline |
getType() const | HighFive::Object | inline |
isValid() const noexcept | HighFive::Object | inline |
Null() | HighFive::DataSpace | inlinestatic |
Object(Object &&other) noexcept | HighFive::Object | inline |
Object() | HighFive::Object | inlineprotected |
Object(const Object &other) | HighFive::Object | inlineprotected |
Object(hid_t) | HighFive::Object | inlineexplicitprotected |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const Object &other) const noexcept | HighFive::Object | inline |
Scalar() | HighFive::DataSpace | inlinestatic |
type | HighFive::DataSpace | static |
UNLIMITED | HighFive::DataSpace | static |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Class representing the space (dimensions) of a DataSet. + More...
+ +#include <H5DataSpace.hpp>
+Public Types | |
enum | DataspaceType { dataspace_scalar +, dataspace_null + } |
An enum to create scalar and null DataSpace with DataSpace::DataSpace(DataspaceType dtype). More... | |
+Public Member Functions | |
DataSpace (const std::vector< size_t > &dims) | |
Create a DataSpace of N-dimensions from a std::vector<size_t>. | |
template<size_t N> | |
DataSpace (const std::array< size_t, N > &dims) | |
Create a DataSpace of N-dimensions from a std::array<size_t, N>. | |
DataSpace (const std::initializer_list< size_t > &dims) | |
Create a DataSpace of N-dimensions from an initializer list. | |
template<typename... Args> | |
DataSpace (size_t dim1, Args... dims) | |
Create a DataSpace of N-dimensions from direct values. | |
template<typename IT , typename = typename std::enable_if<!std::is_integral<IT>::value, IT>::type> | |
DataSpace (const IT begin, const IT end) | |
Create a DataSpace from a pair of iterators. | |
DataSpace (const std::vector< size_t > &dims, const std::vector< size_t > &maxdims) | |
Create a resizable N-dimensional DataSpace. | |
DataSpace (DataspaceType space_type) | |
Create a scalar or a null DataSpace. | |
DataSpace | clone () const |
Create a copy of the DataSpace which will have different id. | |
size_t | getNumberDimensions () const |
Returns the number of dimensions of a DataSpace. | |
std::vector< size_t > | getDimensions () const |
Returns the size of the dataset in each dimension. | |
size_t | getElementCount () const |
Return the number of elements in this DataSpace. | |
std::vector< size_t > | getMaxDimensions () const |
Returns the maximum size of the dataset in each dimension. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Static Public Member Functions | |
static DataSpace | Scalar () |
Create a scalar DataSpace. | |
static DataSpace | Null () |
Create a null DataSpace. | |
template<typename T > | |
static DataSpace | From (const T &value) |
Automatically deduce the DataSpace from a container/value. | |
template<std::size_t N, std::size_t Width> | |
static DataSpace | FromCharArrayStrings (const char(&string_array)[N][Width]) |
Create a DataSpace from a value of type string array. | |
+Static Public Attributes | |
static const ObjectType | type = ObjectType::DataSpace |
static const size_t | UNLIMITED = SIZE_MAX |
Magic value to specify that a DataSpace can grow without limit. | |
+Protected Member Functions | |
DataSpace ()=default | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
+Friends | |
class | Attribute |
class | File |
class | DataSet |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
Class representing the space (dimensions) of a DataSet.
+enum HighFive::DataSpace::DataspaceType | +
An enum to create scalar and null DataSpace with DataSpace::DataSpace(DataspaceType dtype).
+This enum is needed otherwise we will not be able to distringuish between both with normal constructors. Both have a dimension of 0.
Enumerator | |
---|---|
dataspace_scalar | Value to create scalar DataSpace. + |
dataspace_null | Value to create null DataSpace. + |
+
|
+ +inlineexplicit | +
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+
|
+ +inlineexplicit | +
Create a resizable N-dimensional DataSpace.
+dims | Initial size of dataspace |
maxdims | Maximum size of the dataspace |
+
|
+ +inlineexplicit | +
Create a scalar or a null DataSpace.
+This overload enables creating scalar or null data spaces, both have dimension 0.
+space_type | The value from the enum |
+
|
+ +protecteddefault | +
+
|
+ +inline | +
+
|
+ +inlinestatic | +
Automatically deduce the DataSpace from a container/value.
+Certain containers and scalar values are fully supported by HighFive. For these containers, HighFive can deduce the dimensions from value
.
+
|
+ +inlinestatic | +
Create a DataSpace from a value of type string array.
+string_array | An C-array of C-string (null-terminated). |
+
|
+ +inline | +
Returns the size of the dataset in each dimension.
+For zero-dimensional datasets (e.g. scalar or null datasets) an empty vector is returned.
+
+
|
+ +inline | +
+
|
+ +inline | +
Returns the maximum size of the dataset in each dimension.
+This is the maximum size a dataset can be extended to, which may be different from the current size of the dataset.
+
+
|
+ +inline | +
+
|
+ +inlinestatic | +
Create a null DataSpace.
+
+
|
+ +inlinestatic | +
Create a scalar DataSpace.
+
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +static | +
+
|
+ +static | +
Magic value to specify that a DataSpace can grow without limit.
+This value should be used with DataSpace::DataSpace(const std::vector<size_t>& dims, const +std::vector<size_t>& maxdims);
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::DataSpaceException, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
DataSpaceException(const std::string &err_msg) | HighFive::DataSpaceException | inline |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
nextException() const | HighFive::Exception | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Exception specific to HighFive DataSpace interface. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
DataSpaceException (const std::string &err_msg) | |
Public Member Functions inherited from HighFive::Exception | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Exception | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::DataType, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
HDF5 Data Type. + More...
+ +#include <H5DataType.hpp>
+Public Member Functions | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Protected Member Functions | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
+Friends | |
class | Attribute |
class | File |
class | DataSet |
class | CompoundType |
template<typename Derivate > | |
class | NodeTraits |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
HDF5 Data Type.
+
+
|
+ +inline | +
Returns this datatype as a StringType
.
+
|
+ +inlinenoexcept | +
Check the DataType was default constructed.
+ +
+
|
+ +inline | +
Return the fundamental type.
+ +
+
|
+ +inline | +
Get the list of properties for creation of this DataType.
+ +
+
|
+ +inline | +
Returns the length (in bytes) of this type elements.
+Notice that the size of variable length sequences may have limited applicability given that it refers to the size of the control structure. For info see https://support.hdfgroup.org/HDF5/doc/RM/RM_H5T.html#Datatype-GetSize
+ +
+
|
+ +inline | +
Returns whether the type is a fixed-length string.
+ +
+
|
+ +inline | +
Returns whether the type is a Reference.
+ +
+
|
+ +inline | +
Returns whether the type is a variable-length string.
+ +
+
|
+ +inlineprotected | +
+
|
+ +inlineprotected | +
+
|
+ +inlineexplicitprotected | +
+
|
+ +inlineprotectednoexcept | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
Returns a friendly description of the type (e.g. Float32)
+ +
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +friend | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::DataTypeException, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
DataTypeException(const std::string &err_msg) | HighFive::DataTypeException | inline |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
nextException() const | HighFive::Exception | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Exception specific to HighFive DataType interface. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
DataTypeException (const std::string &err_msg) | |
Public Member Functions inherited from HighFive::Exception | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Exception | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Deflate, including all inherited members.
+Deflate(unsigned level) | HighFive::Deflate | inlineexplicit |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5PropertyList.hpp>
+Public Member Functions | |
Deflate (unsigned level) | |
+
|
+ +inlineexplicit | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::ElementSet, including all inherited members.
+ElementSet(std::initializer_list< std::size_t > list) | HighFive::ElementSet | inlineexplicit |
ElementSet(std::initializer_list< std::vector< std::size_t > > list) | HighFive::ElementSet | inlineexplicit |
ElementSet(const std::vector< std::size_t > &element_ids) | HighFive::ElementSet | inlineexplicit |
ElementSet(const std::vector< std::vector< std::size_t > > &element_ids) | HighFive::ElementSet | inlineexplicit |
SliceTraits | HighFive::ElementSet | friend |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Slice_traits.hpp>
+Public Member Functions | |
ElementSet (std::initializer_list< std::size_t > list) | |
Create a list of points of N-dimension for selection. | |
ElementSet (std::initializer_list< std::vector< std::size_t > > list) | |
Create a list of points of N-dimension for selection. | |
ElementSet (const std::vector< std::size_t > &element_ids) | |
Create a list of points of N-dimension for selection. | |
ElementSet (const std::vector< std::vector< std::size_t > > &element_ids) | |
Create a list of points of N-dimension for selection. | |
+Friends | |
template<typename Derivate > | |
class | SliceTraits |
+
|
+ +inlineexplicit | +
Create a list of points of N-dimension for selection.
+list | List of continuous coordinates (e.g.: in 2 dimensions space ElementSet{1, 2, 3 ,4} creates points (1, 2) and (3, 4) ). |
+
|
+ +inlineexplicit | +
Create a list of points of N-dimension for selection.
+list | List of N-dim points. |
+
|
+ +inlineexplicit | +
Create a list of points of N-dimension for selection.
+element_ids | List of continuous coordinates (e.g.: in 2 dimensions space ElementSet{1, 2, 3 ,4} creates points (1, 2) and (3, 4) ). |
+
|
+ +inlineexplicit | +
Create a list of points of N-dimension for selection.
+element_ids | List of N-dim points. |
+
|
+ +friend | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::EnumType< T >, including all inherited members.
+_hid | HighFive::Object | protected |
asStringType() const | HighFive::DataType | inline |
commit(const Object &object, const std::string &name) const | HighFive::EnumType< T > | inline |
empty() const noexcept | HighFive::DataType | inline |
EnumType(const EnumType &other)=default | HighFive::EnumType< T > | |
EnumType(const std::vector< member_def > &t_members) | HighFive::EnumType< T > | inline |
EnumType(std::initializer_list< member_def > t_members) | HighFive::EnumType< T > | inline |
getClass() const | HighFive::DataType | inline |
getCreatePropertyList() const | HighFive::DataType | inline |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getSize() const | HighFive::DataType | inline |
getType() const | HighFive::Object | inline |
isFixedLenStr() const | HighFive::DataType | inline |
isReference() const | HighFive::DataType | inline |
isValid() const noexcept | HighFive::Object | inline |
isVariableStr() const | HighFive::DataType | inline |
Object(Object &&other) noexcept | HighFive::DataType | inlineprotected |
Object() | HighFive::DataType | inlineprotected |
Object(const Object &other) | HighFive::DataType | inlineprotected |
Object(hid_t) | HighFive::DataType | inlineexplicitprotected |
operator!=(const DataType &other) const | HighFive::DataType | inline |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const DataType &other) const | HighFive::DataType | inline |
HighFive::Object::operator==(const Object &other) const noexcept | HighFive::Object | inline |
string() const | HighFive::DataType | inline |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Create a enum HDF5 datatype. + More...
+ +#include <H5DataType.hpp>
+Classes | |
struct | member_def |
Use for defining a member of enum type. More... | |
+Public Member Functions | |
EnumType (const EnumType &other)=default | |
EnumType (const std::vector< member_def > &t_members) | |
EnumType (std::initializer_list< member_def > t_members) | |
void | commit (const Object &object, const std::string &name) const |
Commit datatype into the given Object. | |
Public Member Functions inherited from HighFive::DataType | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::DataType | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
Create a enum HDF5 datatype.
+
+
|
+ +default | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
Commit datatype into the given Object.
+object | Location to commit object into |
name | Name to give the datatype |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::EstimatedLinkInfo, including all inherited members.
+EstimatedLinkInfo(unsigned entries, unsigned length) | HighFive::EstimatedLinkInfo | inlineexplicit |
EstimatedLinkInfo(const GroupCreateProps &gcpl) | HighFive::EstimatedLinkInfo | inlineexplicit |
getEntries() const | HighFive::EstimatedLinkInfo | inline |
getNameLength() const | HighFive::EstimatedLinkInfo | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Set hints as to how many links to expect and their average length. + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
EstimatedLinkInfo (unsigned entries, unsigned length) | |
Create a property with the request parameters. | |
EstimatedLinkInfo (const GroupCreateProps &gcpl) | |
unsigned | getEntries () const |
The estimated number of links in a group. | |
unsigned | getNameLength () const |
The estimated length of the names of links. | |
Set hints as to how many links to expect and their average length.
+
+
|
+ +inlineexplicit | +
Create a property with the request parameters.
+entries | The estimated number of links in a group. |
length | The estimated length of the names of links. |
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
The estimated number of links in a group.
+ +
+
|
+ +inline | +
The estimated length of the names of links.
+ +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Exception, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
HDF5ErrMapper | HighFive::Exception | friend |
nextException() const | HighFive::Exception | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Basic HighFive Exception class. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Protected Attributes | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+Friends | |
struct | HDF5ErrMapper |
+
|
+ +inline | +
+
|
+ +inlinevirtual | +
+
|
+ +inline | +
HDF5 library error mapper.
+
+
|
+ +inline | +
HDF5 library error mapper.
+
+
|
+ +inline | +
nextException
+
+
|
+ +inlinevirtual | +
define the error message
+errmsg |
+
|
+ +inlineoverride | +
get the current exception error message
+
+
|
+ +friend | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+
|
+ +protected | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::File, including all inherited members.
+_hid | HighFive::Object | protected |
Create enum value | HighFive::File | |
createAttribute(const std::string &attribute_name, const DataSpace &space, const DataType &type) | HighFive::AnnotateTraits< File > | inline |
createAttribute(const std::string &attribute_name, const DataSpace &space) | HighFive::AnnotateTraits< File > | inline |
createAttribute(const std::string &attribute_name, const T &data) | HighFive::AnnotateTraits< File > | inline |
createDataSet(const std::string &dataset_name, const DataSpace &space, const DataType &type, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< File > | inline |
createDataSet(const std::string &dataset_name, const DataSpace &space, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< File > | inline |
createDataSet(const std::string &dataset_name, const T &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< File > | inline |
createDataSet(const std::string &dataset_name, const deprecated::FixedLenStringArray< N > &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< File > | inline |
createExternalLink(const std::string &link_name, const std::string &h5_file, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) | HighFive::NodeTraits< File > | inline |
createGroup(const std::string &group_name, bool parents=true) | HighFive::NodeTraits< File > | inline |
createGroup(const std::string &group_name, const GroupCreateProps &createProps, bool parents=true) | HighFive::NodeTraits< File > | inline |
createHardLink(const std::string &link_name, const T &target_obj, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) | HighFive::NodeTraits< File > | inline |
createSoftLink(const std::string &linkName, const T &obj) | HighFive::NodeTraits< File > | inline |
createSoftLink(const std::string &link_name, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) | HighFive::NodeTraits< File > | inline |
Debug enum value | HighFive::File | |
deleteAttribute(const std::string &attribute_name) | HighFive::AnnotateTraits< File > | inline |
Excl enum value | HighFive::File | |
exist(const std::string &node_name) const | HighFive::NodeTraits< File > | inline |
File(const std::string &filename, unsigned openFlags=ReadOnly, const FileAccessProps &fileAccessProps=FileAccessProps::Default()) | HighFive::File | inlineexplicit |
File(const std::string &filename, unsigned openFlags, const FileCreateProps &fileCreateProps, const FileAccessProps &fileAccessProps=FileAccessProps::Default()) | HighFive::File | inline |
File()=default | HighFive::File | protected |
flush() | HighFive::File | inline |
getAccessPropertyList() const | HighFive::File | inline |
getAttribute(const std::string &attribute_name) const | HighFive::AnnotateTraits< File > | inline |
getCreatePropertyList() const | HighFive::File | inline |
getDataSet(const std::string &dataset_name, const DataSetAccessProps &accessProps=DataSetAccessProps::Default()) const | HighFive::NodeTraits< File > | inline |
getDataType(const std::string &type_name, const DataTypeAccessProps &accessProps=DataTypeAccessProps::Default()) const | HighFive::NodeTraits< File > | inline |
getFileSize() const | HighFive::File | inline |
getFreeSpace() const | HighFive::File | inline |
getGroup(const std::string &group_name) const | HighFive::NodeTraits< File > | inline |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getLinkType(const std::string &node_name) const | HighFive::NodeTraits< File > | inline |
getMetadataBlockSize() const | HighFive::File | inline |
getName() const noexcept | HighFive::File | inline |
getNumberAttributes() const | HighFive::AnnotateTraits< File > | inline |
getNumberObjects() const | HighFive::NodeTraits< File > | inline |
getObjectName(size_t index) const | HighFive::NodeTraits< File > | inline |
getObjectType(const std::string &node_name) const | HighFive::NodeTraits< File > | inline |
getPath() const noexcept | HighFive::File | inline |
getType() const | HighFive::Object | inline |
getVersionBounds() const | HighFive::File | inline |
hasAttribute(const std::string &attr_name) const | HighFive::AnnotateTraits< File > | inline |
isValid() const noexcept | HighFive::Object | inline |
listAttributeNames() const | HighFive::AnnotateTraits< File > | inline |
listObjectNames(IndexType idx_type=IndexType::NAME) const | HighFive::NodeTraits< File > | inline |
Object(Object &&other) noexcept | HighFive::File | inlineprotected |
Object() | HighFive::File | inlineprotected |
Object(const Object &other) | HighFive::File | inlineprotected |
Object(hid_t) | HighFive::File | inlineexplicitprotected |
OpenOrCreate enum value | HighFive::File | |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const Object &other) const noexcept | HighFive::Object | inline |
Overwrite enum value | HighFive::File | |
PathTraits | HighFive::File | friend |
ReadOnly enum value | HighFive::File | |
ReadWrite enum value | HighFive::File | |
rename(const std::string &src_path, const std::string &dest_path, bool parents=true) const | HighFive::NodeTraits< File > | inline |
Truncate enum value | HighFive::File | |
type | HighFive::File | static |
unlink(const std::string &node_name) const | HighFive::NodeTraits< File > | inline |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5File.hpp>
+Public Types | |
enum | : unsigned { + ReadOnly = 0x00u +, ReadWrite = 0x01u +, Truncate = 0x02u +, Excl = 0x04u +, + Debug = 0x08u +, Create = 0x10u +, Overwrite = Truncate +, OpenOrCreate = ReadWrite | Create + + } |
+Public Member Functions | |
File (const std::string &filename, unsigned openFlags=ReadOnly, const FileAccessProps &fileAccessProps=FileAccessProps::Default()) | |
File. | |
File (const std::string &filename, unsigned openFlags, const FileCreateProps &fileCreateProps, const FileAccessProps &fileAccessProps=FileAccessProps::Default()) | |
File. | |
const std::string & | getName () const noexcept |
Return the name of the file. | |
std::string | getPath () const noexcept |
Object path of a File is always "/". | |
hsize_t | getMetadataBlockSize () const |
Returns the block size for metadata in bytes. | |
std::pair< H5F_libver_t, H5F_libver_t > | getVersionBounds () const |
Returns the HDF5 version compatibility bounds. | |
void | flush () |
flush | |
FileCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this file. | |
FileAccessProps | getAccessPropertyList () const |
Get the list of properties for accession of this file. | |
size_t | getFileSize () const |
Get the size of this file in bytes. | |
size_t | getFreeSpace () const |
Get the amount of tracked, unused space in bytes. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
Public Member Functions inherited from HighFive::NodeTraits< File > | |
DataSet | createDataSet (const std::string &dataset_name, const DataSpace &space, const DataType &type, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
createDataSet Create a new dataset in the current file of datatype type and of size space | |
DataSet | createDataSet (const std::string &dataset_name, const DataSpace &space, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
createDataSet create a new dataset in the current file with a size specified by space | |
DataSet | createDataSet (const std::string &dataset_name, const T &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
createDataSet create a new dataset in the current file and write to it, inferring the DataSpace from the data. | |
DataSet | createDataSet (const std::string &dataset_name, const deprecated::FixedLenStringArray< N > &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
DataSet | getDataSet (const std::string &dataset_name, const DataSetAccessProps &accessProps=DataSetAccessProps::Default()) const |
get an existing dataset in the current file | |
Group | createGroup (const std::string &group_name, bool parents=true) |
create a new group, and eventually intermediate groups | |
Group | createGroup (const std::string &group_name, const GroupCreateProps &createProps, bool parents=true) |
create a new group, and eventually intermediate groups | |
Group | getGroup (const std::string &group_name) const |
open an existing group with the name group_name | |
DataType | getDataType (const std::string &type_name, const DataTypeAccessProps &accessProps=DataTypeAccessProps::Default()) const |
open a commited datatype with the name type_name | |
size_t | getNumberObjects () const |
return the number of leaf objects of the node / group | |
std::string | getObjectName (size_t index) const |
return the name of the object with the given index | |
bool | rename (const std::string &src_path, const std::string &dest_path, bool parents=true) const |
moves an object and its content within an HDF5 file. | |
std::vector< std::string > | listObjectNames (IndexType idx_type=IndexType::NAME) const |
list all leaf objects name of the node / group | |
bool | exist (const std::string &node_name) const |
check a dataset or group exists in the current node / group | |
void | unlink (const std::string &node_name) const |
unlink the given dataset or group | |
LinkType | getLinkType (const std::string &node_name) const |
Returns the kind of link of the given name (soft, hard...) | |
ObjectType | getObjectType (const std::string &node_name) const |
A shorthand to get the kind of object pointed to (group, dataset, type...) | |
void | createSoftLink (const std::string &linkName, const T &obj) |
A shorthand to create softlink to any object which provides getPath The link will be created with default properties along with required parent groups. | |
void | createSoftLink (const std::string &link_name, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) |
Creates softlinks. | |
void | createExternalLink (const std::string &link_name, const std::string &h5_file, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) |
void | createHardLink (const std::string &link_name, const T &target_obj, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) |
Creates hardlinks. | |
Public Member Functions inherited from HighFive::AnnotateTraits< File > | |
Attribute | createAttribute (const std::string &attribute_name, const DataSpace &space, const DataType &type) |
create a new attribute with the name attribute_name | |
Attribute | createAttribute (const std::string &attribute_name, const DataSpace &space) |
createAttribute create a new attribute on the current dataset with size specified by space | |
Attribute | createAttribute (const std::string &attribute_name, const T &data) |
createAttribute create a new attribute on the current dataset and write to it, inferring the DataSpace from data. | |
void | deleteAttribute (const std::string &attribute_name) |
deleteAttribute let you delete an attribute by its name. | |
Attribute | getAttribute (const std::string &attribute_name) const |
open an existing attribute with the name attribute_name | |
size_t | getNumberAttributes () const |
return the number of attributes of the node / group | |
std::vector< std::string > | listAttributeNames () const |
list all attribute name of the node / group | |
bool | hasAttribute (const std::string &attr_name) const |
checks an attribute exists | |
+Static Public Attributes | |
static const ObjectType | type = ObjectType::File |
+Protected Member Functions | |
File ()=default | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
+Friends | |
template<typename > | |
class | PathTraits |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
File class.
+anonymous enum : unsigned | +
+
|
+ +inlineexplicit | +
File.
+filename | filepath of the HDF5 file |
openFlags | Open mode / flags ( ReadOnly, ReadWrite) |
fileAccessProps | the file access properties |
Open or create a new HDF5 file
+ +
+
|
+ +inline | +
File.
+filename | filepath of the HDF5 file |
openFlags | Open mode / flags ( ReadOnly, ReadWrite) |
fileCreateProps | the file create properties |
fileAccessProps | the file access properties |
Open or create a new HDF5 file
+ +
+
|
+ +protecteddefault | +
+
|
+ +inline | +
flush
+Flushes all buffers associated with a file to disk
+ +
+
|
+ +inline | +
Get the list of properties for accession of this file.
+ +
+
|
+ +inline | +
Get the list of properties for creation of this file.
+ +
+
|
+ +inline | +
Get the size of this file in bytes.
+ +
+
|
+ +inline | +
Get the amount of tracked, unused space in bytes.
+Note, this is a wrapper for H5Fget_freespace
and returns the number bytes in the free space manager. This might be different from the total amount of unused space in the HDF5 file, since the free space manager might not track everything or not track across open-close cycles.
+
|
+ +inline | +
Returns the block size for metadata in bytes.
+ +
+
|
+ +inlinenoexcept | +
Return the name of the file.
+ +
+
|
+ +inlinenoexcept | +
+
|
+ +inline | +
Returns the HDF5 version compatibility bounds.
+ +
+
|
+ +inlineprotected | +
+
|
+ +inlineprotected | +
+
|
+ +inlineexplicitprotected | +
+
|
+ +inlineprotectednoexcept | +
+
|
+ +friend | +
+
|
+ +static | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::FileDriver, including all inherited members.
+_hid | HighFive::Object | protected |
_initializeIfNeeded() | HighFive::PropertyList< T > | inlineprotected |
add(const P &property) | HighFive::PropertyList< T > | inline |
Default() noexcept | HighFive::PropertyList< T > | inlinestatic |
Empty() | HighFive::PropertyList< T > | inlinestatic |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getType() const noexcept | HighFive::PropertyList< T > | inline |
isValid() const noexcept | HighFive::Object | inline |
Object(Object &&other) noexcept | HighFive::Object | inline |
Object() | HighFive::Object | inlineprotected |
Object(const Object &other) | HighFive::Object | inlineprotected |
Object(hid_t) | HighFive::Object | inlineexplicitprotected |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const Object &other) const noexcept | HighFive::Object | inline |
PropertyListBase() noexcept | HighFive::PropertyListBase | inline |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
file driver base concept + More...
+ +#include <H5FileDriver.hpp>
+Additional Inherited Members | |
Public Member Functions inherited from HighFive::PropertyList< T > | |
constexpr PropertyType | getType () const noexcept |
return the type of this PropertyList | |
template<PropertyInterface P> | |
void | add (const P &property) |
Public Member Functions inherited from HighFive::PropertyListBase | |
PropertyListBase () noexcept | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
Static Public Member Functions inherited from HighFive::PropertyList< T > | |
static const PropertyList< T > & | Default () noexcept |
Return the Default property type object. | |
static PropertyList< T > | Empty () |
Static Public Member Functions inherited from HighFive::PropertyListBase | |
static const PropertyListBase & | Default () noexcept |
Protected Member Functions inherited from HighFive::PropertyList< T > | |
void | _initializeIfNeeded () |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
file driver base concept
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::FileException, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
FileException(const std::string &err_msg) | HighFive::FileException | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
nextException() const | HighFive::Exception | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Exception specific to HighFive File interface. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
FileException (const std::string &err_msg) | |
Public Member Functions inherited from HighFive::Exception | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Exception | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::FileVersionBounds, including all inherited members.
+FileVersionBounds(H5F_libver_t low, H5F_libver_t high) | HighFive::FileVersionBounds | inline |
FileVersionBounds(const FileAccessProps &fapl) | HighFive::FileVersionBounds | inlineexplicit |
getVersion() const | HighFive::FileVersionBounds | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Configure the version bounds for the file. + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
FileVersionBounds (H5F_libver_t low, H5F_libver_t high) | |
FileVersionBounds (const FileAccessProps &fapl) | |
std::pair< H5F_libver_t, H5F_libver_t > | getVersion () const |
Configure the version bounds for the file.
+Used to define the compatibility of objects created within HDF5 files, and affects the format of groups stored in the file.
+See also the documentation of H5P_SET_LIBVER_BOUNDS
in HDF5.
Possible values for low
and high
are:
H5F_LIBVER_EARLIEST
H5F_LIBVER_V18
H5F_LIBVER_V110
H5F_LIBVER_NBOUNDS
H5F_LIBVER_LATEST
currently defined as H5F_LIBVER_V110
within HDF5
+
|
+ +inline | +
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::FixedLengthStringType, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5DataType.hpp>
+Public Member Functions | |
FixedLengthStringType (size_t size, StringPadding padding, CharacterSet character_set=CharacterSet::Ascii) | |
Create a fixed length string datatype. | |
Public Member Functions inherited from HighFive::StringType | |
CharacterSet | getCharacterSet () const |
For stings return the character set. | |
StringPadding | getPadding () const |
For fixed length stings return the padding. | |
Public Member Functions inherited from HighFive::DataType | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::DataType | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
+
|
+ +inline | +
Create a fixed length string datatype.
+The string will be size
bytes long, regardless whether it's ASCII or UTF8. In particular, a string with n
UFT8 characters in general requires 4*n
bytes.
The string padding is subtle, essentially it's just a hint. A null-terminated string is guaranteed to have one ‘’\0'which marks the semantic end of the string. The length of the buffer must be at least
sizebytes regardless. HDF5 will read or write
sizebytes, irrespective of the when the
\0` occurs.
Note that when writing passing StringPadding::NullTerminated
is a guarantee to the reader that it contains a \0
. Therefore, make sure that the string really is nullterminated. Otherwise prefer a null-padded string which only means states that the buffer is filled up with 0 or more \0
.
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Group, including all inherited members.
+_file_obj | HighFive::PathTraits< Group > | protected |
_hid | HighFive::Object | protected |
createAttribute(const std::string &attribute_name, const DataSpace &space, const DataType &type) | HighFive::AnnotateTraits< Group > | inline |
createAttribute(const std::string &attribute_name, const DataSpace &space) | HighFive::AnnotateTraits< Group > | inline |
createAttribute(const std::string &attribute_name, const T &data) | HighFive::AnnotateTraits< Group > | inline |
createDataSet(const std::string &dataset_name, const DataSpace &space, const DataType &type, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< Group > | inline |
createDataSet(const std::string &dataset_name, const DataSpace &space, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< Group > | inline |
createDataSet(const std::string &dataset_name, const T &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< Group > | inline |
createDataSet(const std::string &dataset_name, const deprecated::FixedLenStringArray< N > &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< Group > | inline |
createExternalLink(const std::string &link_name, const std::string &h5_file, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) | HighFive::NodeTraits< Group > | inline |
createGroup(const std::string &group_name, bool parents=true) | HighFive::NodeTraits< Group > | inline |
createGroup(const std::string &group_name, const GroupCreateProps &createProps, bool parents=true) | HighFive::NodeTraits< Group > | inline |
createHardLink(const std::string &link_name, const T &target_obj, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) | HighFive::NodeTraits< Group > | inline |
createSoftLink(const std::string &linkName, const T &obj) | HighFive::NodeTraits< Group > | inline |
createSoftLink(const std::string &link_name, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) | HighFive::NodeTraits< Group > | inline |
deleteAttribute(const std::string &attribute_name) | HighFive::AnnotateTraits< Group > | inline |
exist(const std::string &node_name) const | HighFive::NodeTraits< Group > | inline |
File | HighFive::Group | friend |
getAttribute(const std::string &attribute_name) const | HighFive::AnnotateTraits< Group > | inline |
getCreatePropertyList() const | HighFive::Group | inline |
getDataSet(const std::string &dataset_name, const DataSetAccessProps &accessProps=DataSetAccessProps::Default()) const | HighFive::NodeTraits< Group > | inline |
getDataType(const std::string &type_name, const DataTypeAccessProps &accessProps=DataTypeAccessProps::Default()) const | HighFive::NodeTraits< Group > | inline |
getEstimatedLinkInfo() const | HighFive::Group | inline |
getFile() const noexcept | HighFive::PathTraits< Group > | inline |
getGroup(const std::string &group_name) const | HighFive::NodeTraits< Group > | inline |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getLinkType(const std::string &node_name) const | HighFive::NodeTraits< Group > | inline |
getNumberAttributes() const | HighFive::AnnotateTraits< Group > | inline |
getNumberObjects() const | HighFive::NodeTraits< Group > | inline |
getObjectName(size_t index) const | HighFive::NodeTraits< Group > | inline |
getObjectType(const std::string &node_name) const | HighFive::NodeTraits< Group > | inline |
getPath() const | HighFive::PathTraits< Group > | inline |
getType() const | HighFive::Object | inline |
Group()=default | HighFive::Group | |
Group(Object &&o) noexcept | HighFive::Group | inline |
hasAttribute(const std::string &attr_name) const | HighFive::AnnotateTraits< Group > | inline |
isValid() const noexcept | HighFive::Object | inline |
listAttributeNames() const | HighFive::AnnotateTraits< Group > | inline |
listObjectNames(IndexType idx_type=IndexType::NAME) const | HighFive::NodeTraits< Group > | inline |
Object(Object &&other) noexcept | HighFive::Group | inlineprotected |
Object() | HighFive::Group | inlineprotected |
Object(const Object &other) | HighFive::Group | inlineprotected |
Object(hid_t) | HighFive::Group | inlineexplicitprotected |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const Object &other) const noexcept | HighFive::Object | inline |
PathTraits() | HighFive::PathTraits< Group > | inline |
Reference | HighFive::Group | friend |
rename(const std::string &src_path, const std::string &dest_path, bool parents=true) const | HighFive::NodeTraits< Group > | inline |
type | HighFive::Group | static |
unlink(const std::string &node_name) const | HighFive::NodeTraits< Group > | inline |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Represents an hdf5 group. + More...
+ +#include <H5Group.hpp>
+Public Member Functions | |
Group ()=default | |
std::pair< unsigned int, unsigned int > | getEstimatedLinkInfo () const |
GroupCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this group. | |
Group (Object &&o) noexcept | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
Public Member Functions inherited from HighFive::NodeTraits< Group > | |
DataSet | createDataSet (const std::string &dataset_name, const DataSpace &space, const DataType &type, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
createDataSet Create a new dataset in the current file of datatype type and of size space | |
DataSet | createDataSet (const std::string &dataset_name, const DataSpace &space, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
createDataSet create a new dataset in the current file with a size specified by space | |
DataSet | createDataSet (const std::string &dataset_name, const T &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
createDataSet create a new dataset in the current file and write to it, inferring the DataSpace from the data. | |
DataSet | createDataSet (const std::string &dataset_name, const deprecated::FixedLenStringArray< N > &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
DataSet | getDataSet (const std::string &dataset_name, const DataSetAccessProps &accessProps=DataSetAccessProps::Default()) const |
get an existing dataset in the current file | |
Group | createGroup (const std::string &group_name, bool parents=true) |
create a new group, and eventually intermediate groups | |
Group | createGroup (const std::string &group_name, const GroupCreateProps &createProps, bool parents=true) |
create a new group, and eventually intermediate groups | |
Group | getGroup (const std::string &group_name) const |
open an existing group with the name group_name | |
DataType | getDataType (const std::string &type_name, const DataTypeAccessProps &accessProps=DataTypeAccessProps::Default()) const |
open a commited datatype with the name type_name | |
size_t | getNumberObjects () const |
return the number of leaf objects of the node / group | |
std::string | getObjectName (size_t index) const |
return the name of the object with the given index | |
bool | rename (const std::string &src_path, const std::string &dest_path, bool parents=true) const |
moves an object and its content within an HDF5 file. | |
std::vector< std::string > | listObjectNames (IndexType idx_type=IndexType::NAME) const |
list all leaf objects name of the node / group | |
bool | exist (const std::string &node_name) const |
check a dataset or group exists in the current node / group | |
void | unlink (const std::string &node_name) const |
unlink the given dataset or group | |
LinkType | getLinkType (const std::string &node_name) const |
Returns the kind of link of the given name (soft, hard...) | |
ObjectType | getObjectType (const std::string &node_name) const |
A shorthand to get the kind of object pointed to (group, dataset, type...) | |
void | createSoftLink (const std::string &linkName, const T &obj) |
A shorthand to create softlink to any object which provides getPath The link will be created with default properties along with required parent groups. | |
void | createSoftLink (const std::string &link_name, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) |
Creates softlinks. | |
void | createExternalLink (const std::string &link_name, const std::string &h5_file, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) |
void | createHardLink (const std::string &link_name, const T &target_obj, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) |
Creates hardlinks. | |
Public Member Functions inherited from HighFive::AnnotateTraits< Group > | |
Attribute | createAttribute (const std::string &attribute_name, const DataSpace &space, const DataType &type) |
create a new attribute with the name attribute_name | |
Attribute | createAttribute (const std::string &attribute_name, const DataSpace &space) |
createAttribute create a new attribute on the current dataset with size specified by space | |
Attribute | createAttribute (const std::string &attribute_name, const T &data) |
createAttribute create a new attribute on the current dataset and write to it, inferring the DataSpace from data. | |
void | deleteAttribute (const std::string &attribute_name) |
deleteAttribute let you delete an attribute by its name. | |
Attribute | getAttribute (const std::string &attribute_name) const |
open an existing attribute with the name attribute_name | |
size_t | getNumberAttributes () const |
return the number of attributes of the node / group | |
std::vector< std::string > | listAttributeNames () const |
list all attribute name of the node / group | |
bool | hasAttribute (const std::string &attr_name) const |
checks an attribute exists | |
Public Member Functions inherited from HighFive::PathTraits< Group > | |
PathTraits () | |
std::string | getPath () const |
return the path to the current object | |
File & | getFile () const noexcept |
Return a reference to the File object this object belongs. | |
+Static Public Attributes | |
static const ObjectType | type = ObjectType::Group |
+Protected Member Functions | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
+Friends | |
class | File |
class | Reference |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
Protected Attributes inherited from HighFive::PathTraits< Group > | |
std::shared_ptr< File > | _file_obj |
Represents an hdf5 group.
+
+
|
+ +default | +
+
|
+ +inlinenoexcept | +
+
|
+ +inline | +
Get the list of properties for creation of this group.
+ +
+
|
+ +inline | +
+
|
+ +inlineprotected | +
+
|
+ +inlineprotected | +
+
|
+ +inlineexplicitprotected | +
+
|
+ +inlineprotectednoexcept | +
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +static | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::GroupException, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
GroupException(const std::string &err_msg) | HighFive::GroupException | inline |
nextException() const | HighFive::Exception | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Exception specific to HighFive Group interface. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
GroupException (const std::string &err_msg) | |
Public Member Functions inherited from HighFive::Exception | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Exception | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::HyperSlab, including all inherited members.
+apply(const DataSpace &space_) const | HighFive::HyperSlab | inline |
HyperSlab() | HighFive::HyperSlab | inline |
HyperSlab(const RegularHyperSlab &sel) | HighFive::HyperSlab | inlineexplicit |
notA(const RegularHyperSlab &sel) | HighFive::HyperSlab | inline |
notB(const RegularHyperSlab &sel) | HighFive::HyperSlab | inline |
operator&(const RegularHyperSlab &sel) const | HighFive::HyperSlab | inline |
operator&=(const RegularHyperSlab &sel) | HighFive::HyperSlab | inline |
operator^(const RegularHyperSlab &sel) const | HighFive::HyperSlab | inline |
operator^=(const RegularHyperSlab &sel) | HighFive::HyperSlab | inline |
operator|(const RegularHyperSlab &sel) const | HighFive::HyperSlab | inline |
operator|=(const RegularHyperSlab &sel) | HighFive::HyperSlab | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Slice_traits.hpp>
+Public Member Functions | |
HyperSlab () | |
HyperSlab (const RegularHyperSlab &sel) | |
HyperSlab | operator| (const RegularHyperSlab &sel) const |
HyperSlab & | operator|= (const RegularHyperSlab &sel) |
HyperSlab | operator& (const RegularHyperSlab &sel) const |
HyperSlab & | operator&= (const RegularHyperSlab &sel) |
HyperSlab | operator^ (const RegularHyperSlab &sel) const |
HyperSlab & | operator^= (const RegularHyperSlab &sel) |
HyperSlab & | notA (const RegularHyperSlab &sel) |
HyperSlab & | notB (const RegularHyperSlab &sel) |
DataSpace | apply (const DataSpace &space_) const |
+
|
+ +inline | +
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::LinkCreationOrder, including all inherited members.
+fromPropertyList(hid_t hid) | HighFive::LinkCreationOrder | inlineprotected |
getFlags() const | HighFive::LinkCreationOrder | inline |
LinkCreationOrder(unsigned flags) | HighFive::LinkCreationOrder | inlineexplicit |
LinkCreationOrder(const FileCreateProps &fcpl) | HighFive::LinkCreationOrder | inlineexplicit |
LinkCreationOrder(const GroupCreateProps &gcpl) | HighFive::LinkCreationOrder | explicit |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Track and index creation order time. + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
LinkCreationOrder (unsigned flags) | |
Create the property. | |
LinkCreationOrder (const FileCreateProps &fcpl) | |
LinkCreationOrder (const GroupCreateProps &gcpl) | |
unsigned | getFlags () const |
+Protected Member Functions | |
void | fromPropertyList (hid_t hid) |
Track and index creation order time.
+Let user retrieve objects by creation order time instead of name.
+
+
|
+ +inlineexplicit | +
Create the property.
+flags | Should be a composition of HighFive::CreationOrder. |
+
|
+ +inlineexplicit | +
+
|
+ +explicit | +
+
|
+ +inlineprotected | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Logger, including all inherited members.
+callback_type typedef | HighFive::Logger | |
log(LogSeverity severity, const std::string &message, const std::string &file, int line) | HighFive::Logger | inline |
Logger()=delete | HighFive::Logger | |
Logger(const Logger &)=delete | HighFive::Logger | |
Logger(Logger &&)=delete | HighFive::Logger | |
Logger(callback_type cb) | HighFive::Logger | inlineexplicit |
operator=(const Logger &)=delete | HighFive::Logger | |
operator=(Logger &&)=delete | HighFive::Logger | |
set_logging_callback(callback_type cb) | HighFive::Logger | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
A logger with supporting basic functionality. + More...
+ +#include <H5Utility.hpp>
+Public Types | |
using | callback_type |
+Public Member Functions | |
Logger ()=delete | |
Logger (const Logger &)=delete | |
Logger (Logger &&)=delete | |
Logger (callback_type cb) | |
Logger & | operator= (const Logger &)=delete |
Logger & | operator= (Logger &&)=delete |
void | log (LogSeverity severity, const std::string &message, const std::string &file, int line) |
void | set_logging_callback (callback_type cb) |
A logger with supporting basic functionality.
+This logger delegates the logging task to a callback. This level of indirection enables using the default Python logger from C++; or integrating HighFive into some custom logging solution.
+Using this class directly to log is not intended. Rather you should use
HIGHFIVE_LOG_DEBUG{,_IF}
HIGHFIVE_LOG_INFO{,_IF}
HIGHFIVE_LOG_WARNING{,_IF}
HIGHFIVE_LOG_ERROR{,_IF}
This is intended to used as a singleton, via get_global_logger()
.
using HighFive::Logger::callback_type | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +delete | +
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::MPIOFileAccess, including all inherited members.
+MPIOFileAccess(MPI_Comm comm, MPI_Info info) | HighFive::MPIOFileAccess | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Configure MPI access for the file. + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
MPIOFileAccess (MPI_Comm comm, MPI_Info info) | |
Configure MPI access for the file.
+All further modifications to the structure of the file will have to be done with collective operations
+
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::MPIOFileDriver, including all inherited members.
+_hid | HighFive::Object | protected |
_initializeIfNeeded() | HighFive::PropertyList< T > | inlineprotected |
add(const P &property) | HighFive::PropertyList< T > | inline |
Default() noexcept | HighFive::PropertyList< T > | inlinestatic |
Empty() | HighFive::PropertyList< T > | inlinestatic |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getType() const noexcept | HighFive::PropertyList< T > | inline |
isValid() const noexcept | HighFive::Object | inline |
MPIOFileDriver(MPI_Comm mpi_comm, MPI_Info mpi_info) | HighFive::MPIOFileDriver | inline |
Object(Object &&other) noexcept | HighFive::Object | inline |
Object() | HighFive::Object | inlineprotected |
Object(const Object &other) | HighFive::Object | inlineprotected |
Object(hid_t) | HighFive::Object | inlineexplicitprotected |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const Object &other) const noexcept | HighFive::Object | inline |
PropertyListBase() noexcept | HighFive::PropertyListBase | inline |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
MPIIO Driver for Parallel HDF5. + More...
+ +#include <H5FileDriver.hpp>
+Public Member Functions | |
MPIOFileDriver (MPI_Comm mpi_comm, MPI_Info mpi_info) | |
Public Member Functions inherited from HighFive::PropertyList< T > | |
constexpr PropertyType | getType () const noexcept |
return the type of this PropertyList | |
template<PropertyInterface P> | |
void | add (const P &property) |
Public Member Functions inherited from HighFive::PropertyListBase | |
PropertyListBase () noexcept | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Static Public Member Functions inherited from HighFive::PropertyList< T > | |
static const PropertyList< T > & | Default () noexcept |
Return the Default property type object. | |
static PropertyList< T > | Empty () |
Static Public Member Functions inherited from HighFive::PropertyListBase | |
static const PropertyListBase & | Default () noexcept |
Protected Member Functions inherited from HighFive::PropertyList< T > | |
void | _initializeIfNeeded () |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
MPIIO Driver for Parallel HDF5.
+
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::MetadataBlockSize, including all inherited members.
+getSize() const | HighFive::MetadataBlockSize | inline |
MetadataBlockSize(hsize_t size) | HighFive::MetadataBlockSize | inlineexplicit |
MetadataBlockSize(const FileAccessProps &fapl) | HighFive::MetadataBlockSize | inlineexplicit |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Configure the metadata block size to use writing to files. + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
MetadataBlockSize (hsize_t size) | |
MetadataBlockSize (const FileAccessProps &fapl) | |
hsize_t | getSize () const |
Configure the metadata block size to use writing to files.
+size | Metadata block size in bytes |
+
|
+ +inlineexplicit | +
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::MpioNoCollectiveCause, including all inherited members.
+getCause() const | HighFive::MpioNoCollectiveCause | inline |
getGlobalCause() const | HighFive::MpioNoCollectiveCause | inline |
getLocalCause() const | HighFive::MpioNoCollectiveCause | inline |
MpioNoCollectiveCause(const DataTransferProps &dxpl) | HighFive::MpioNoCollectiveCause | inlineexplicit |
wasCollective() const | HighFive::MpioNoCollectiveCause | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
The cause for non-collective I/O. + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
MpioNoCollectiveCause (const DataTransferProps &dxpl) | |
bool | wasCollective () const |
Was the datatransfer collective? | |
uint32_t | getLocalCause () const |
The local cause for a non-collective I/O. | |
uint32_t | getGlobalCause () const |
The global cause for a non-collective I/O. | |
std::pair< uint32_t, uint32_t > | getCause () const |
A pair of the local and global cause for non-collective I/O. | |
The cause for non-collective I/O.
+The cause refers to the most recent I/O with data transfer property list dxpl
at time of creation of this object. This object will not update automatically for later data transfers, i.e. H5Pget_mpio_no_collective_cause
is called in the constructor, and not when fetching a value, such as wasCollective
.
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
A pair of the local and global cause for non-collective I/O.
+ +
+
|
+ +inline | +
The global cause for a non-collective I/O.
+ +
+
|
+ +inline | +
The local cause for a non-collective I/O.
+ +
+
|
+ +inline | +
Was the datatransfer collective?
+ +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::NodeTraits< Derivate >, including all inherited members.
+createDataSet(const std::string &dataset_name, const DataSpace &space, const DataType &type, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< Derivate > | inline |
createDataSet(const std::string &dataset_name, const DataSpace &space, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< Derivate > | inline |
createDataSet(const std::string &dataset_name, const T &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< Derivate > | inline |
createDataSet(const std::string &dataset_name, const deprecated::FixedLenStringArray< N > &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) | HighFive::NodeTraits< Derivate > | inline |
createExternalLink(const std::string &link_name, const std::string &h5_file, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) | HighFive::NodeTraits< Derivate > | inline |
createGroup(const std::string &group_name, bool parents=true) | HighFive::NodeTraits< Derivate > | inline |
createGroup(const std::string &group_name, const GroupCreateProps &createProps, bool parents=true) | HighFive::NodeTraits< Derivate > | inline |
createHardLink(const std::string &link_name, const T &target_obj, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) | HighFive::NodeTraits< Derivate > | inline |
createSoftLink(const std::string &linkName, const T &obj) | HighFive::NodeTraits< Derivate > | inline |
createSoftLink(const std::string &link_name, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) | HighFive::NodeTraits< Derivate > | inline |
exist(const std::string &node_name) const | HighFive::NodeTraits< Derivate > | inline |
getDataSet(const std::string &dataset_name, const DataSetAccessProps &accessProps=DataSetAccessProps::Default()) const | HighFive::NodeTraits< Derivate > | inline |
getDataType(const std::string &type_name, const DataTypeAccessProps &accessProps=DataTypeAccessProps::Default()) const | HighFive::NodeTraits< Derivate > | inline |
getGroup(const std::string &group_name) const | HighFive::NodeTraits< Derivate > | inline |
getLinkType(const std::string &node_name) const | HighFive::NodeTraits< Derivate > | inline |
getNumberObjects() const | HighFive::NodeTraits< Derivate > | inline |
getObjectName(size_t index) const | HighFive::NodeTraits< Derivate > | inline |
getObjectType(const std::string &node_name) const | HighFive::NodeTraits< Derivate > | inline |
listObjectNames(IndexType idx_type=IndexType::NAME) const | HighFive::NodeTraits< Derivate > | inline |
rename(const std::string &src_path, const std::string &dest_path, bool parents=true) const | HighFive::NodeTraits< Derivate > | inline |
unlink(const std::string &node_name) const | HighFive::NodeTraits< Derivate > | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
NodeTraits: Base class for Group and File. + More...
+ +#include <H5Node_traits.hpp>
+Public Member Functions | |
DataSet | createDataSet (const std::string &dataset_name, const DataSpace &space, const DataType &type, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
createDataSet Create a new dataset in the current file of datatype type and of size space | |
template<typename T > | |
DataSet | createDataSet (const std::string &dataset_name, const DataSpace &space, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
createDataSet create a new dataset in the current file with a size specified by space | |
template<typename T > | |
DataSet | createDataSet (const std::string &dataset_name, const T &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
createDataSet create a new dataset in the current file and write to it, inferring the DataSpace from the data. | |
template<std::size_t N> | |
DataSet | createDataSet (const std::string &dataset_name, const deprecated::FixedLenStringArray< N > &data, const DataSetCreateProps &createProps=DataSetCreateProps::Default(), const DataSetAccessProps &accessProps=DataSetAccessProps::Default(), bool parents=true) |
DataSet | getDataSet (const std::string &dataset_name, const DataSetAccessProps &accessProps=DataSetAccessProps::Default()) const |
get an existing dataset in the current file | |
Group | createGroup (const std::string &group_name, bool parents=true) |
create a new group, and eventually intermediate groups | |
Group | createGroup (const std::string &group_name, const GroupCreateProps &createProps, bool parents=true) |
create a new group, and eventually intermediate groups | |
Group | getGroup (const std::string &group_name) const |
open an existing group with the name group_name | |
DataType | getDataType (const std::string &type_name, const DataTypeAccessProps &accessProps=DataTypeAccessProps::Default()) const |
open a commited datatype with the name type_name | |
size_t | getNumberObjects () const |
return the number of leaf objects of the node / group | |
std::string | getObjectName (size_t index) const |
return the name of the object with the given index | |
bool | rename (const std::string &src_path, const std::string &dest_path, bool parents=true) const |
moves an object and its content within an HDF5 file. | |
std::vector< std::string > | listObjectNames (IndexType idx_type=IndexType::NAME) const |
list all leaf objects name of the node / group | |
bool | exist (const std::string &node_name) const |
check a dataset or group exists in the current node / group | |
void | unlink (const std::string &node_name) const |
unlink the given dataset or group | |
LinkType | getLinkType (const std::string &node_name) const |
Returns the kind of link of the given name (soft, hard...) | |
ObjectType | getObjectType (const std::string &node_name) const |
A shorthand to get the kind of object pointed to (group, dataset, type...) | |
template<typename T , typename = decltype(&T::getPath)> | |
void | createSoftLink (const std::string &linkName, const T &obj) |
A shorthand to create softlink to any object which provides getPath The link will be created with default properties along with required parent groups. | |
void | createSoftLink (const std::string &link_name, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) |
Creates softlinks. | |
void | createExternalLink (const std::string &link_name, const std::string &h5_file, const std::string &obj_path, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) |
template<typename T , typename = decltype(&T::getPath)> | |
void | createHardLink (const std::string &link_name, const T &target_obj, LinkCreateProps linkCreateProps=LinkCreateProps(), const LinkAccessProps &linkAccessProps=LinkAccessProps(), const bool parents=true) |
Creates hardlinks. | |
NodeTraits: Base class for Group and File.
+
+
|
+ +inline | +
createDataSet create a new dataset in the current file with a size specified by space
+dataset_name | identifier of the dataset |
space | Associated DataSpace, see DataSpace for more information |
createProps | A property list with data set creation properties |
accessProps | A property list with data set access properties |
parents | Create intermediate groups if needed. Default: true. |
+
|
+ +inline | +
createDataSet Create a new dataset in the current file of datatype type and of size space
+dataset_name | identifier of the dataset |
space | Associated DataSpace, see DataSpace for more information |
type | Type of Data |
createProps | A property list with data set creation properties |
accessProps | A property list with data set access properties |
parents | Create intermediate groups if needed. Default: true. |
+
|
+ +inline | +
+
|
+ +inline | +
createDataSet create a new dataset in the current file and write to it, inferring the DataSpace from the data.
+dataset_name | identifier of the dataset |
data | Associated data, must support DataSpace::From, see DataSpace for more information |
createProps | A property list with data set creation properties |
accessProps | A property list with data set access properties |
parents | Create intermediate groups if needed. Default: true. |
+
|
+ +inline | +
+
|
+ +inline | +
create a new group, and eventually intermediate groups
+group_name | |
parents | Create intermediate groups if needed. Default: true. |
+
|
+ +inline | +
create a new group, and eventually intermediate groups
+group_name | |
createProps | A property list with group creation properties |
parents | Create intermediate groups if needed. Default: true. |
+
|
+ +inline | +
Creates hardlinks.
+link_name | The name of the link |
target_obj | The target object |
linkCreateProps | A Link_Create property list. Notice "parents=true" overrides |
linkAccessProps | The Link_Access property list |
parents | Whether parent groups should be created: Default: true |
+
|
+ +inline | +
Creates softlinks.
+link_name | The name of the link |
obj_path | The target object path |
linkCreateProps | A Link_Create property list. Notice "parents=true" overrides |
linkAccessProps | The Link_Access property list |
parents | Whether parent groups should be created: Default: true |
+
|
+ +inline | +
A shorthand to create softlink to any object which provides getPath
The link will be created with default properties along with required parent groups.
+
|
+ +inline | +
check a dataset or group exists in the current node / group
+node_name | dataset/group name to check |
+
|
+ +inline | +
get an existing dataset in the current file
+dataset_name | |
accessProps | property list to configure dataset chunk cache |
+
|
+ +inline | +
open a commited datatype with the name type_name
+type_name |
+
|
+ +inline | +
open an existing group with the name group_name
+group_name |
+
|
+ +inline | +
Returns the kind of link of the given name (soft, hard...)
+node_name | The entry to check, path relative to the current group |
+
|
+ +inline | +
return the number of leaf objects of the node / group
+
+
|
+ +inline | +
return the name of the object with the given index
+
+
|
+ +inline | +
A shorthand to get the kind of object pointed to (group, dataset, type...)
+node_name | The entry to check, path relative to the current group |
+
|
+ +inline | +
list all leaf objects name of the node / group
+idx_type | tell if the list should be ordered by Name or CreationOrderTime. CreationOrderTime can be use only if the file/group has been created with the HighFive::LinkCreationTime property. |
+
|
+ +inline | +
moves an object and its content within an HDF5 file.
+src_path | relative path of the object to current File/Group |
dest_path | new relative path of the object to current File/Group |
parents | Create intermediate groups if needed. Default: true. |
+
|
+ +inline | +
unlink the given dataset or group
+node_name | dataset/group name to unlink |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Object, including all inherited members.
+_hid | HighFive::Object | protected |
CompoundType | HighFive::Object | friend |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getType() const | HighFive::Object | inline |
isValid() const noexcept | HighFive::Object | inline |
Object(Object &&other) noexcept | HighFive::Object | inline |
Object() | HighFive::Object | inlineprotected |
Object(const Object &other) | HighFive::Object | inlineprotected |
Object(hid_t) | HighFive::Object | inlineexplicitprotected |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const Object &other) const noexcept | HighFive::Object | inline |
Reference | HighFive::Object | friend |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Object.hpp>
+Public Member Functions | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Protected Member Functions | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
+Protected Attributes | |
hid_t | _hid |
+Friends | |
class | Reference |
class | CompoundType |
+
|
+ +inlinenoexcept | +
+
|
+ +inline | +
+
|
+ +inlineprotected | +
+
|
+ +inlineprotected | +
+
|
+ +inlineexplicitprotected | +
+
|
+ +inlinenoexcept | +
getId
+
+
|
+ +inline | +
Retrieve several infos about the current object (address, dates, etc)
+ +
+
|
+ +inline | +
Gets the fundamental type of the object (dataset, group, etc)
+ObjectException | when the _hid is negative or the type is custom and not registered yet |
+
|
+ +inlinenoexcept | +
isValid
+
+
|
+ +inlineprotected | +
+
|
+ +inlinenoexcept | +
+
|
+ +friend | +
+
|
+ +friend | +
+
|
+ +protected | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::ObjectException, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
nextException() const | HighFive::Exception | inline |
ObjectException(const std::string &err_msg) | HighFive::ObjectException | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Exception specific to HighFive Object interface. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
ObjectException (const std::string &err_msg) | |
Public Member Functions inherited from HighFive::Exception | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Exception | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::ObjectInfo, including all inherited members.
+getAddress() const noexcept | HighFive::ObjectInfo | inline |
getCreationTime() const noexcept | HighFive::ObjectInfo | inline |
getModificationTime() const noexcept | HighFive::ObjectInfo | inline |
getRefCount() const noexcept | HighFive::ObjectInfo | inline |
Object | HighFive::ObjectInfo | friend |
raw_info | HighFive::ObjectInfo | protected |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
A class for accessing hdf5 objects info. + More...
+ +#include <H5Object.hpp>
+Public Member Functions | |
haddr_t | getAddress () const noexcept |
Retrieve the address of the object (within its file) | |
size_t | getRefCount () const noexcept |
Retrieve the number of references to this object. | |
time_t | getCreationTime () const noexcept |
Retrieve the object's creation time. | |
time_t | getModificationTime () const noexcept |
Retrieve the object's last modification time. | |
+Protected Attributes | |
H5O_info_t | raw_info |
+Friends | |
class | Object |
A class for accessing hdf5 objects info.
+
+
|
+ +inlinenoexcept | +
Retrieve the address of the object (within its file)
+
+
|
+ +inlinenoexcept | +
Retrieve the object's creation time.
+ +
+
|
+ +inlinenoexcept | +
Retrieve the object's last modification time.
+ +
+
|
+ +inlinenoexcept | +
Retrieve the number of references to this object.
+ +
+
|
+ +friend | +
+
|
+ +protected | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::PathTraits< Derivate >, including all inherited members.
+_file_obj | HighFive::PathTraits< Derivate > | protected |
getFile() const noexcept | HighFive::PathTraits< Derivate > | inline |
getPath() const | HighFive::PathTraits< Derivate > | inline |
PathTraits() | HighFive::PathTraits< Derivate > | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Path_traits.hpp>
+Public Member Functions | |
PathTraits () | |
std::string | getPath () const |
return the path to the current object | |
File & | getFile () const noexcept |
Return a reference to the File object this object belongs. | |
+Protected Attributes | |
std::shared_ptr< File > | _file_obj |
+
|
+ +inline | +
+
|
+ +inlinenoexcept | +
+
|
+ +inline | +
return the path to the current object
+
+
|
+ +protected | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::PropertyException, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
nextException() const | HighFive::Exception | inline |
PropertyException(const std::string &err_msg) | HighFive::PropertyException | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Exception specific to HighFive Property interface. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
PropertyException (const std::string &err_msg) | |
Public Member Functions inherited from HighFive::Exception | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Exception | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::PropertyList< T >, including all inherited members.
+_hid | HighFive::Object | protected |
_initializeIfNeeded() | HighFive::PropertyList< T > | inlineprotected |
add(const P &property) | HighFive::PropertyList< T > | inline |
Default() noexcept | HighFive::PropertyList< T > | inlinestatic |
Empty() | HighFive::PropertyList< T > | inlinestatic |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getType() const noexcept | HighFive::PropertyList< T > | inline |
isValid() const noexcept | HighFive::Object | inline |
Object(Object &&other) noexcept | HighFive::Object | inline |
Object() | HighFive::Object | inlineprotected |
Object(const Object &other) | HighFive::Object | inlineprotected |
Object(hid_t) | HighFive::Object | inlineexplicitprotected |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const Object &other) const noexcept | HighFive::Object | inline |
PropertyListBase() noexcept | HighFive::PropertyListBase | inline |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
HDF5 property Lists. + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
constexpr PropertyType | getType () const noexcept |
return the type of this PropertyList | |
template<PropertyInterface P> | |
void | add (const P &property) |
Public Member Functions inherited from HighFive::PropertyListBase | |
PropertyListBase () noexcept | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Static Public Member Functions | |
static const PropertyList< T > & | Default () noexcept |
Return the Default property type object. | |
static PropertyList< T > | Empty () |
Static Public Member Functions inherited from HighFive::PropertyListBase | |
static const PropertyListBase & | Default () noexcept |
+Protected Member Functions | |
void | _initializeIfNeeded () |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
HDF5 property Lists.
+
+
|
+ +inlineprotected | +
+
|
+ +inline | +
Add a property to this property list. A property is an object which is expected to have a method with the following signature void apply(hid_t hid) const
PropertyInterface |
+
|
+ +inlinestaticnoexcept | +
Return the Default property type object.
+ +
+
|
+ +inlinestatic | +
+
|
+ +inlineconstexprnoexcept | +
return the type of this PropertyList
+ +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::PropertyListBase, including all inherited members.
+_hid | HighFive::Object | protected |
Default() noexcept | HighFive::PropertyListBase | inlinestatic |
getId() const noexcept | HighFive::Object | inline |
getInfo() const | HighFive::Object | inline |
getType() const | HighFive::Object | inline |
isValid() const noexcept | HighFive::Object | inline |
Object(Object &&other) noexcept | HighFive::Object | inline |
Object() | HighFive::Object | inlineprotected |
Object(const Object &other) | HighFive::Object | inlineprotected |
Object(hid_t) | HighFive::Object | inlineexplicitprotected |
operator=(const Object &other) | HighFive::Object | inlineprotected |
operator==(const Object &other) const noexcept | HighFive::Object | inline |
PropertyListBase() noexcept | HighFive::PropertyListBase | inline |
~Object() | HighFive::Object | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Base Class for Property lists, providing global default. + More...
+ +#include <H5PropertyList.hpp>
+Public Member Functions | |
PropertyListBase () noexcept | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Static Public Member Functions | |
static const PropertyListBase & | Default () noexcept |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
Base Class for Property lists, providing global default.
+
+
|
+ +inlinenoexcept | +
+
|
+ +inlinestaticnoexcept | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::RawPropertyList< T >, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5PropertyList.hpp>
+Public Member Functions | |
template<typename F , typename... Args> | |
void | add (const F &funct, const Args &... args) |
Public Member Functions inherited from HighFive::PropertyList< T > | |
constexpr PropertyType | getType () const noexcept |
return the type of this PropertyList | |
template<PropertyInterface P> | |
void | add (const P &property) |
Public Member Functions inherited from HighFive::PropertyListBase | |
PropertyListBase () noexcept | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Static Public Member Functions inherited from HighFive::PropertyList< T > | |
static const PropertyList< T > & | Default () noexcept |
Return the Default property type object. | |
static PropertyList< T > | Empty () |
Static Public Member Functions inherited from HighFive::PropertyListBase | |
static const PropertyListBase & | Default () noexcept |
Protected Member Functions inherited from HighFive::PropertyList< T > | |
void | _initializeIfNeeded () |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
RawPropertyLists are to be used when advanced H5 properties are desired and are not part of the HighFive API. Therefore this class is mainly for internal use.
+
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Reference, including all inherited members.
+create_ref(hobj_ref_t *refptr) const | HighFive::Reference | inlineprotected |
dereference(const Object &location) const | HighFive::Reference | inline |
getType(const Object &location) const | HighFive::Reference | inline |
Reference()=default | HighFive::Reference | |
Reference(const Object &location, const Object &object) | HighFive::Reference | inline |
Reference(const hobj_ref_t h5_ref) | HighFive::Reference | inlineexplicitprotected |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
An HDF5 (object) reference type. + More...
+ +#include <H5Reference.hpp>
+Public Member Functions | |
Reference ()=default | |
Create an empty Reference to be initialized later. | |
Reference (const Object &location, const Object &object) | |
Create a Reference to an object residing at a given location. | |
template<typename T > | |
T | dereference (const Object &location) const |
Retrieve the Object being referenced by the Reference. | |
ObjectType | getType (const Object &location) const |
Get only the type of the referenced Object. | |
+Protected Member Functions | |
Reference (const hobj_ref_t h5_ref) | |
Create a Reference from a low-level HDF5 object reference. | |
void | create_ref (hobj_ref_t *refptr) const |
Create the low-level reference and store it at refptr. | |
An HDF5 (object) reference type.
+HDF5 object references allow pointing to groups, datasets (and compound types). They differ from links in their ability to be stored and retrieved as data from the HDF5 file in datasets themselves.
+
+
|
+ +default | +
Create an empty Reference to be initialized later.
+ +
+
|
+ +inlineexplicitprotected | +
Create a Reference from a low-level HDF5 object reference.
+ +
+
|
+ +inlineprotected | +
Create the low-level reference and store it at refptr.
+refptr | Pointer to a memory location where the created HDF5 reference will be stored |
+
|
+ +inline | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::ReferenceException, including all inherited members.
+_err_major | HighFive::Exception | protected |
_err_minor | HighFive::Exception | protected |
_errmsg | HighFive::Exception | protected |
_next | HighFive::Exception | protected |
Exception(const std::string &err_msg) | HighFive::Exception | inline |
getErrMajor() const | HighFive::Exception | inline |
getErrMinor() const | HighFive::Exception | inline |
nextException() const | HighFive::Exception | inline |
ReferenceException(const std::string &err_msg) | HighFive::ReferenceException | inline |
setErrorMsg(const std::string &errmsg) | HighFive::Exception | inlinevirtual |
what() const override | HighFive::Exception | inline |
~Exception() | HighFive::Exception | inlinevirtual |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Exception specific to HighFive Reference interface. + More...
+ +#include <H5Exception.hpp>
+Public Member Functions | |
ReferenceException (const std::string &err_msg) | |
Public Member Functions inherited from HighFive::Exception | |
Exception (const std::string &err_msg) | |
virtual | ~Exception () throw () |
const char * | what () const override throw () |
get the current exception error message | |
virtual void | setErrorMsg (const std::string &errmsg) |
define the error message | |
Exception * | nextException () const |
nextException | |
hid_t | getErrMajor () const |
HDF5 library error mapper. | |
hid_t | getErrMinor () const |
HDF5 library error mapper. | |
+Additional Inherited Members | |
Protected Attributes inherited from HighFive::Exception | |
std::string | _errmsg |
std::shared_ptr< Exception > | _next |
hid_t | _err_major |
hid_t | _err_minor |
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Selection, including all inherited members.
+getDataset() noexcept | HighFive::Selection | inline |
getDataset() const noexcept | HighFive::Selection | inline |
getDataType() const | HighFive::Selection | inline |
getMemSpace() const noexcept | HighFive::Selection | inline |
getSpace() const noexcept | HighFive::Selection | inline |
read(const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< Selection > | inline |
read(T &array, const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< Selection > | inline |
read_raw(T *array, const DataType &dtype, const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< Selection > | inline |
read_raw(T *array, const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< Selection > | inline |
select(const HyperSlab &hyperslab) const | HighFive::SliceTraits< Selection > | inline |
select(const HyperSlab &hyperslab, const DataSpace &memspace) const | HighFive::SliceTraits< Selection > | inline |
select(const std::vector< size_t > &offset, const std::vector< size_t > &count, const std::vector< size_t > &stride={}, const std::vector< size_t > &block={}) const | HighFive::SliceTraits< Selection > | inline |
select(const std::vector< size_t > &columns) const | HighFive::SliceTraits< Selection > | inline |
select(const ElementSet &elements) const | HighFive::SliceTraits< Selection > | inline |
Selection(const DataSpace &memspace, const DataSpace &file_space, const DataSet &set) | HighFive::Selection | inlineprotected |
write(const T &buffer, const DataTransferProps &xfer_props=DataTransferProps()) | HighFive::SliceTraits< Selection > | inline |
write_raw(const T *buffer, const DataType &mem_datatype, const DataTransferProps &xfer_props=DataTransferProps()) | HighFive::SliceTraits< Selection > | inline |
write_raw(const T *buffer, const DataTransferProps &xfer_props=DataTransferProps()) | HighFive::SliceTraits< Selection > | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Selection: represent a view on a slice/part of a dataset. + More...
+ +#include <H5Selection.hpp>
+Public Member Functions | |
DataSpace | getSpace () const noexcept |
getSpace | |
DataSpace | getMemSpace () const noexcept |
getMemSpace | |
DataSet & | getDataset () noexcept |
getDataSet | |
const DataSet & | getDataset () const noexcept |
const DataType | getDataType () const |
return the datatype of the selection | |
Public Member Functions inherited from HighFive::SliceTraits< Selection > | |
Selection | select (const HyperSlab &hyperslab) const |
Select an hyperslab in the current Slice/Dataset. | |
Selection | select (const HyperSlab &hyperslab, const DataSpace &memspace) const |
Select an hyperslab in the current Slice/Dataset. | |
Selection | select (const std::vector< size_t > &offset, const std::vector< size_t > &count, const std::vector< size_t > &stride={}, const std::vector< size_t > &block={}) const |
Select a region in the current Slice/Dataset of count points at offset separated by stride . If strides are not provided they will default to 1 in all dimensions. | |
Selection | select (const std::vector< size_t > &columns) const |
Select a set of columns in the last dimension of this dataset. | |
Selection | select (const ElementSet &elements) const |
Select a region in the current Slice/Dataset out of a list of elements. | |
T | read (const DataTransferProps &xfer_props=DataTransferProps()) const |
void | read (T &array, const DataTransferProps &xfer_props=DataTransferProps()) const |
void | read_raw (T *array, const DataType &dtype, const DataTransferProps &xfer_props=DataTransferProps()) const |
void | read_raw (T *array, const DataTransferProps &xfer_props=DataTransferProps()) const |
void | write (const T &buffer, const DataTransferProps &xfer_props=DataTransferProps()) |
void | write_raw (const T *buffer, const DataType &mem_datatype, const DataTransferProps &xfer_props=DataTransferProps()) |
void | write_raw (const T *buffer, const DataTransferProps &xfer_props=DataTransferProps()) |
+Protected Member Functions | |
Selection (const DataSpace &memspace, const DataSpace &file_space, const DataSet &set) | |
Selection: represent a view on a slice/part of a dataset.
+A Selection is valid only if its parent dataset is valid
+
+
|
+ +inlineprotected | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
getDataSet
+
+
|
+ +inline | +
return the datatype of the selection
+
+
|
+ +inlinenoexcept | +
getMemSpace
+
+
|
+ +inlinenoexcept | +
getSpace
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Shuffle, including all inherited members.
+Shuffle()=default | HighFive::Shuffle |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5PropertyList.hpp>
+Public Member Functions | |
Shuffle ()=default | |
+
|
+ +default | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::SilenceHDF5, including all inherited members.
+SilenceHDF5(bool enable=true) | HighFive::SilenceHDF5 | inline |
~SilenceHDF5() | HighFive::SilenceHDF5 | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Utility class to disable HDF5 stack printing inside a scope. + More...
+ +#include <H5Utility.hpp>
+Public Member Functions | |
SilenceHDF5 (bool enable=true) | |
~SilenceHDF5 () | |
Utility class to disable HDF5 stack printing inside a scope.
+
+
|
+ +inline | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::SliceTraits< Derivate >, including all inherited members.
+read(const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< Derivate > | inline |
read(T &array, const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< Derivate > | inline |
read_raw(T *array, const DataType &dtype, const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< Derivate > | inline |
read_raw(T *array, const DataTransferProps &xfer_props=DataTransferProps()) const | HighFive::SliceTraits< Derivate > | inline |
select(const HyperSlab &hyperslab) const | HighFive::SliceTraits< Derivate > | inline |
select(const HyperSlab &hyperslab, const DataSpace &memspace) const | HighFive::SliceTraits< Derivate > | inline |
select(const std::vector< size_t > &offset, const std::vector< size_t > &count, const std::vector< size_t > &stride={}, const std::vector< size_t > &block={}) const | HighFive::SliceTraits< Derivate > | inline |
select(const std::vector< size_t > &columns) const | HighFive::SliceTraits< Derivate > | inline |
select(const ElementSet &elements) const | HighFive::SliceTraits< Derivate > | inline |
write(const T &buffer, const DataTransferProps &xfer_props=DataTransferProps()) | HighFive::SliceTraits< Derivate > | inline |
write_raw(const T *buffer, const DataType &mem_datatype, const DataTransferProps &xfer_props=DataTransferProps()) | HighFive::SliceTraits< Derivate > | inline |
write_raw(const T *buffer, const DataTransferProps &xfer_props=DataTransferProps()) | HighFive::SliceTraits< Derivate > | inline |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Slice_traits.hpp>
+Public Member Functions | |
Selection | select (const HyperSlab &hyperslab) const |
Select an hyperslab in the current Slice/Dataset. | |
Selection | select (const HyperSlab &hyperslab, const DataSpace &memspace) const |
Select an hyperslab in the current Slice/Dataset. | |
Selection | select (const std::vector< size_t > &offset, const std::vector< size_t > &count, const std::vector< size_t > &stride={}, const std::vector< size_t > &block={}) const |
Select a region in the current Slice/Dataset of count points at offset separated by stride . If strides are not provided they will default to 1 in all dimensions. | |
Selection | select (const std::vector< size_t > &columns) const |
Select a set of columns in the last dimension of this dataset. | |
Selection | select (const ElementSet &elements) const |
Select a region in the current Slice/Dataset out of a list of elements. | |
template<typename T > | |
T | read (const DataTransferProps &xfer_props=DataTransferProps()) const |
template<typename T > | |
void | read (T &array, const DataTransferProps &xfer_props=DataTransferProps()) const |
template<typename T > | |
void | read_raw (T *array, const DataType &dtype, const DataTransferProps &xfer_props=DataTransferProps()) const |
template<typename T > | |
void | read_raw (T *array, const DataTransferProps &xfer_props=DataTransferProps()) const |
template<typename T > | |
void | write (const T &buffer, const DataTransferProps &xfer_props=DataTransferProps()) |
template<typename T > | |
void | write_raw (const T *buffer, const DataType &mem_datatype, const DataTransferProps &xfer_props=DataTransferProps()) |
template<typename T > | |
void | write_raw (const T *buffer, const DataTransferProps &xfer_props=DataTransferProps()) |
+
|
+ +inline | +
+
|
+ +inline | +
Read the entire dataset into a buffer
+An exception is raised is if the numbers of dimension of the buffer and of the dataset are different.
+The array type can be a N-pointer or a N-vector. For plain pointers not dimensionality checking will be performed, it is the user's responsibility to ensure that the right amount of space has been allocated.
+ +
+
|
+ +inline | +
Read the entire dataset into a raw buffer
+Same as read(T*, const DataType&, const DataTransferProps&)
. However, this overload deduces the HDF5 datatype of the element of array
from T
. Note, that the file datatype is already fixed.
array | A buffer containing enough space for the data |
xfer_props | Data Transfer properties |
+
|
+ +inline | +
Read the entire dataset into a raw buffer
+No dimensionality checks will be performed, it is the user's responsibility to ensure that the right amount of space has been allocated.
array | A buffer containing enough space for the data |
dtype | The type of the data, in case it cannot be automatically guessed |
xfer_props | Data Transfer properties |
+
|
+ +inline | +
Select a region in the current Slice/Dataset out of a list of elements.
+ +
+
|
+ +inline | +
Select an hyperslab
in the current Slice/Dataset.
HyperSlabs can be either regular or irregular. Irregular hyperslabs are typically generated by taking the union of regular hyperslabs. An irregular hyperslab, in general, does not fit nicely into a multi-dimensional array, but only a subset of such an array.
+Therefore, the only memspaces supported for general hyperslabs are one-dimensional arrays.
+ +
+
|
+ +inline | +
Select an hyperslab
in the current Slice/Dataset.
If the selection can be read into a simple, multi-dimensional dataspace, then this overload enable specifying the shape of the memory dataspace with memspace
. Note, that simple implies no offsets, strides or number of blocks, just the size of the block in each dimension.
+
|
+ +inline | +
Select a set of columns in the last dimension of this dataset.
+The column indices must be smaller than the dimension size.
+ +
+
|
+ +inline | +
Select a region in the current Slice/Dataset of count
points at offset
separated by stride
. If strides are not provided they will default to 1 in all dimensions.
vector offset and count have to be from the same dimension
+ +
+
|
+ +inline | +
Write the integrality N-dimension buffer to this dataset An exception is raised is if the numbers of dimension of the buffer and of the dataset are different
+The array type can be a N-pointer or a N-vector ( e.g int** integer two dimensional array )
+ +
+
|
+ +inline | +
Write from a raw pointer into this dataset.
+Same as write_raw(const T*, const DataTransferProps&)
. However, this overload attempts to guess the data type of buffer
, i.e. the memory datatype. Note that the file datatype is already fixed.
+
|
+ +inline | +
Write from a raw pointer into this dataset.
+No dimensionality checks will be performed, it is the user's responsibility to ensure that the buffer holds the right amount of elements. For n-dimensional matrices the buffer layout follows H5 default conventions.
+Note, this is the shallowest wrapper around H5Dwrite
and should be used if full control is needed. Generally prefer write
.
buffer | A buffer containing the data to be written |
dtype | The datatype of buffer , i.e. the memory data type. |
xfer_props | The HDF5 data transfer properties, e.g. collective MPI-IO. |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::StringType, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5DataType.hpp>
+Public Member Functions | |
CharacterSet | getCharacterSet () const |
For stings return the character set. | |
StringPadding | getPadding () const |
For fixed length stings return the padding. | |
Public Member Functions inherited from HighFive::DataType | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Friends | |
class | DataType |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::DataType | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
+
|
+ +inline | +
For stings return the character set.
+ +
+
|
+ +inline | +
For fixed length stings return the padding.
+ +
+
|
+ +friend | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::Szip, including all inherited members.
+getOptionsMask() const | HighFive::Szip | inline |
getPixelsPerBlock() const | HighFive::Szip | inline |
Szip(unsigned options_mask=H5_SZIP_EC_OPTION_MASK, unsigned pixels_per_block=H5_SZIP_MAX_PIXELS_PER_BLOCK) | HighFive::Szip | inlineexplicit |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5PropertyList.hpp>
+Public Member Functions | |
Szip (unsigned options_mask=H5_SZIP_EC_OPTION_MASK, unsigned pixels_per_block=H5_SZIP_MAX_PIXELS_PER_BLOCK) | |
unsigned | getOptionsMask () const |
unsigned | getPixelsPerBlock () const |
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
+
|
+ +inline | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::UseCollectiveIO, including all inherited members.
+isCollective() const | HighFive::UseCollectiveIO | inline |
UseCollectiveIO(bool enable=true) | HighFive::UseCollectiveIO | inlineexplicit |
UseCollectiveIO(const DataTransferProps &dxpl) | HighFive::UseCollectiveIO | inlineexplicit |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5PropertyList.hpp>
+Public Member Functions | |
UseCollectiveIO (bool enable=true) | |
UseCollectiveIO (const DataTransferProps &dxpl) | |
bool | isCollective () const |
Does the property request collective IO? | |
+
|
+ +inlineexplicit | +
+
|
+ +inlineexplicit | +
+
|
+ +inline | +
Does the property request collective IO?
+ +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::VariableLengthStringType, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5DataType.hpp>
+Public Member Functions | |
VariableLengthStringType (CharacterSet character_set=CharacterSet::Ascii) | |
Create a variable length string HDF5 datatype. | |
Public Member Functions inherited from HighFive::StringType | |
CharacterSet | getCharacterSet () const |
For stings return the character set. | |
StringPadding | getPadding () const |
For fixed length stings return the padding. | |
Public Member Functions inherited from HighFive::DataType | |
bool | operator== (const DataType &other) const |
bool | operator!= (const DataType &other) const |
DataTypeClass | getClass () const |
Return the fundamental type. | |
size_t | getSize () const |
Returns the length (in bytes) of this type elements. | |
std::string | string () const |
Returns a friendly description of the type (e.g. Float32) | |
bool | isVariableStr () const |
Returns whether the type is a variable-length string. | |
bool | isFixedLenStr () const |
Returns whether the type is a fixed-length string. | |
StringType | asStringType () const |
Returns this datatype as a StringType . | |
bool | empty () const noexcept |
Check the DataType was default constructed. | |
bool | isReference () const |
Returns whether the type is a Reference. | |
DataTypeCreateProps | getCreatePropertyList () const |
Get the list of properties for creation of this DataType. | |
Public Member Functions inherited from HighFive::Object | |
Object (Object &&other) noexcept | |
~Object () | |
bool | isValid () const noexcept |
isValid | |
hid_t | getId () const noexcept |
getId | |
ObjectInfo | getInfo () const |
Retrieve several infos about the current object (address, dates, etc) | |
ObjectType | getType () const |
Gets the fundamental type of the object (dataset, group, etc) | |
bool | operator== (const Object &other) const noexcept |
+Additional Inherited Members | |
Protected Member Functions inherited from HighFive::DataType | |
Object (Object &&other) noexcept | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Protected Member Functions inherited from HighFive::Object | |
Object () | |
Object (const Object &other) | |
Object (hid_t) | |
Object & | operator= (const Object &other) |
Protected Attributes inherited from HighFive::Object | |
hid_t | _hid |
+
|
+ +inline | +
Create a variable length string HDF5 datatype.
+ +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This is the complete list of members for HighFive::deprecated::FixedLenStringArray< N >, including all inherited members.
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
A structure representing a set of fixed-length strings. + More...
+ +#include <H5DataType.hpp>
+Public Types | |
using | iterator = typename vector_t::iterator |
using | const_iterator = typename vector_t::const_iterator |
using | reverse_iterator = typename vector_t::reverse_iterator |
using | const_reverse_iterator = typename vector_t::const_reverse_iterator |
using | value_type = typename vector_t::value_type |
+Public Member Functions | |
FixedLenStringArray ()=default | |
FixedLenStringArray (const char array[][N], std::size_t n_strings) | |
Create a FixedStringArray from a raw contiguous buffer. | |
FixedLenStringArray (const std::vector< std::string > &vec) | |
Create a FixedStringArray from a sequence of strings. | |
FixedLenStringArray (const std::string *iter_begin, const std::string *iter_end) | |
FixedLenStringArray (const std::initializer_list< std::string > &) | |
void | push_back (const std::string &) |
Append an std::string to the buffer structure. | |
void | push_back (const std::array< char, N > &) |
std::string | getString (std::size_t index) const |
Retrieve a string from the structure as std::string. | |
const char * | operator[] (std::size_t i) const noexcept |
const char * | at (std::size_t i) const |
bool | empty () const noexcept |
std::size_t | size () const noexcept |
void | resize (std::size_t n) |
const char * | front () const |
const char * | back () const |
char * | data () noexcept |
const char * | data () const noexcept |
iterator | begin () noexcept |
iterator | end () noexcept |
const_iterator | begin () const noexcept |
const_iterator | cbegin () const noexcept |
const_iterator | end () const noexcept |
const_iterator | cend () const noexcept |
reverse_iterator | rbegin () noexcept |
reverse_iterator | rend () noexcept |
const_reverse_iterator | rbegin () const noexcept |
const_reverse_iterator | rend () const noexcept |
A structure representing a set of fixed-length strings.
+Although fixed-len arrays can be created 'raw' without the need for this structure, to retrieve results efficiently it must be used.
+N | Size of the string in bytes, including the null character. Note, that all string must be null-terminated. |
using HighFive::deprecated::FixedLenStringArray< N >::const_iterator = typename vector_t::const_iterator | +
using HighFive::deprecated::FixedLenStringArray< N >::const_reverse_iterator = typename vector_t::const_reverse_iterator | +
using HighFive::deprecated::FixedLenStringArray< N >::iterator = typename vector_t::iterator | +
using HighFive::deprecated::FixedLenStringArray< N >::reverse_iterator = typename vector_t::reverse_iterator | +
using HighFive::deprecated::FixedLenStringArray< N >::value_type = typename vector_t::value_type | +
+
|
+ +default | +
+
|
+ +inline | +
Create a FixedStringArray from a raw contiguous buffer.
+The argument n_strings
specifies the number of strings.
+
|
+ +inlineexplicit | +
Create a FixedStringArray from a sequence of strings.
+Such conversion involves a copy, original vector is not modified
+ +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inline | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inline | +
+
|
+ +inline | +
Retrieve a string from the structure as std::string.
+ +
+
|
+ +inlinenoexcept | +
+
|
+ +inline | +
+
|
+ +inline | +
Append an std::string to the buffer structure.
+ +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inlinenoexcept | +
+
|
+ +inline | +
+
|
+ +inlinenoexcept | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
File in highfive | Includes file in highfive/h5easy_bits |
---|---|
H5Easy.hpp | H5Easy_Eigen.hpp |
H5Easy.hpp | H5Easy_misc.hpp |
H5Easy.hpp | H5Easy_opencv.hpp |
H5Easy.hpp | H5Easy_public.hpp |
H5Easy.hpp | H5Easy_scalar.hpp |
H5Easy.hpp | H5Easy_vector.hpp |
H5Easy.hpp | H5Easy_xtensor.hpp |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+Files | |
H5_definitions.hpp | |
h5_wrapper.hpp | |
h5a_wrapper.hpp | |
H5Annotate_traits.hpp | |
H5Annotate_traits_misc.hpp | |
H5Attribute_misc.hpp | |
H5Converter_misc.hpp | |
h5d_wrapper.hpp | |
H5DataSet_misc.hpp | |
H5Dataspace_misc.hpp | |
H5DataType_misc.hpp | |
h5e_wrapper.hpp | |
H5Exception_misc.hpp | |
h5f_wrapper.hpp | |
H5File_misc.hpp | |
H5FileDriver_misc.hpp | |
H5Friends.hpp | |
h5g_wrapper.hpp | |
h5i_wrapper.hpp | |
H5Inspector_decl.hpp | |
H5Inspector_misc.hpp | |
H5Iterables_misc.hpp | |
h5l_wrapper.hpp | |
H5Node_traits.hpp | |
H5Node_traits_misc.hpp | |
h5o_wrapper.hpp | |
H5Object_misc.hpp | |
h5p_wrapper.hpp | |
H5Path_traits.hpp | |
H5Path_traits_misc.hpp | |
H5PropertyList_misc.hpp | |
h5r_wrapper.hpp | |
H5ReadWrite_misc.hpp | |
H5Reference_misc.hpp | |
h5s_wrapper.hpp | |
H5Selection_misc.hpp | |
H5Slice_traits.hpp | |
H5Slice_traits_misc.hpp | |
h5t_wrapper.hpp | |
H5Utils.hpp | |
string_padding.hpp | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+Directories | |
bits | |
h5easy_bits | |
+Files | |
boost.hpp | |
eigen.hpp | |
H5Attribute.hpp | |
H5DataSet.hpp | |
H5DataSpace.hpp | |
H5DataType.hpp | |
H5Easy.hpp | |
H5Exception.hpp | |
H5File.hpp | |
H5FileDriver.hpp | |
H5Group.hpp | |
H5Object.hpp | |
H5PropertyList.hpp | |
H5Reference.hpp | |
H5Selection.hpp | |
H5Utility.hpp | |
H5Version.hpp | |
half_float.hpp | |
highfive.hpp | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+Files | |
H5Easy_Eigen.hpp | |
H5Easy_misc.hpp | |
H5Easy_opencv.hpp | |
H5Easy_public.hpp | |
H5Easy_scalar.hpp | |
H5Easy_vector.hpp | |
H5Easy_xtensor.hpp | |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
This page explains how to interpret the graphs that are generated by doxygen.
+Consider the following example:
This will result in the following graph:
+The boxes in the above graph have the following meaning:
+The arrows have the following meaning:
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
HDF5 is configured through what they call property lists. In HDF5 the process has four steps:
+hid_t
identifying the property list.Note that the mental picture is that one creates a settings object, and then passes those settings to a function such as H5Dwrite
. In and of themselves the settings don't change the behaviour of HDF5. Rather they need to be used to take affect.
The second aspect is that property lists represent any number of related settings, e.g. there's property lists anything related to creating files and another for accessing files, same for creating and accessing datasets, etc. Settings that affect creating files, must be passed a file creation property list, while settings that affect file access require a file access property list.
+In HighFive the PropertyList
works similar in that it's a object representing the settings, i.e. internally it's just the property lists HID. Just like in HDF5 one adds the settings to the settings object; and then passes the settings object to the respective method. Example:
// Create an object which contains the setting to +// open files with MPI-IO. +auto fapl = FileAccessProps(); +fapl.add(MPIOFileAccess(MPI_COMM_WORLD, MPI_INFO_NULL); + +// To open a specific file with MPI-IO, we do: +auto file = File("foo.h5", File::ReadOnly, fapl); +
Note that the MPIOFileAccess
object by itself doesn't affect the FileAccessProps
. Rather it needs to be explicitly added to the fapl
(the group of file access related settings), and then the fapl
needs to be passed to the constructor of File
for the settings to take affect.
This is important to understand when reading properties. Example:
// Obtain the file access property list: +auto fapl = file.getAccessPropertyList() + +// Extracts a copy of the collective MPI-IO metadata settings from +// the group of file access related setting, i.e. the `fapl`: +auto mpio_metadata = MPIOCollectiveMetadata(fapl); + +if(mpio_metadata.isCollectiveRead()) { + // something specific if meta data is read collectively. +} + +// Careful, this only affects the `mpio_metadata` object, but not the +// `fapl`, and also not whether `file` uses collective MPI-IO for +// metadata. +mpio_metadata = MPIOCollectiveMetadata(false, false); +
+Classes | |
class | HighFive::PropertyListBase |
Base Class for Property lists, providing global default. More... | |
class | HighFive::PropertyList< T > |
HDF5 property Lists. More... | |
class | HighFive::RawPropertyList< T > |
class | HighFive::MPIOFileAccess |
Configure MPI access for the file. More... | |
class | HighFive::FileVersionBounds |
Configure the version bounds for the file. More... | |
class | HighFive::MetadataBlockSize |
Configure the metadata block size to use writing to files. More... | |
class | HighFive::EstimatedLinkInfo |
Set hints as to how many links to expect and their average length. More... | |
class | HighFive::Chunking |
class | HighFive::Deflate |
class | HighFive::Szip |
class | HighFive::Shuffle |
class | HighFive::AllocationTime |
When are datasets allocated? More... | |
class | HighFive::Caching |
class | HighFive::CreateIntermediateGroup |
class | HighFive::UseCollectiveIO |
class | HighFive::MpioNoCollectiveCause |
The cause for non-collective I/O. More... | |
struct | HighFive::CreationOrder |
class | HighFive::LinkCreationOrder |
Track and index creation order time. More... | |
class | HighFive::AttributePhaseChange |
Set threshold for attribute storage. More... | |
interface | PropertyInterface |
HDF5 file property object. More... | |
using HighFive::AttributeCreateProps = PropertyList<PropertyType::ATTRIBUTE_CREATE> | +
using HighFive::DataSetAccessProps = PropertyList<PropertyType::DATASET_ACCESS> | +
using HighFive::DataSetCreateProps = PropertyList<PropertyType::DATASET_CREATE> | +
using HighFive::DataTransferProps = PropertyList<PropertyType::DATASET_XFER> | +
using HighFive::DataTypeAccessProps = PropertyList<PropertyType::DATATYPE_ACCESS> | +
using HighFive::DataTypeCreateProps = PropertyList<PropertyType::DATATYPE_CREATE> | +
using HighFive::FileAccessProps = PropertyList<PropertyType::FILE_ACCESS> | +
using HighFive::FileCreateProps = PropertyList<PropertyType::FILE_CREATE> | +
using HighFive::GroupAccessProps = PropertyList<PropertyType::GROUP_ACCESS> | +
using HighFive::GroupCreateProps = PropertyList<PropertyType::GROUP_CREATE> | +
using HighFive::LinkAccessProps = PropertyList<PropertyType::LINK_ACCESS> | +
using HighFive::LinkCreateProps = PropertyList<PropertyType::LINK_CREATE> | +
using HighFive::ObjectCopyProps = PropertyList<PropertyType::OBJECT_COPY> | +
using HighFive::ObjectCreateProps = PropertyList<PropertyType::OBJECT_CREATE> | +
using HighFive::StringCreateProps = PropertyList<PropertyType::STRING_CREATE> | +
+
|
+ +strong | +
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5public.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Apublic.h>
#include <H5Ipublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Dpublic.h>
#include <H5Ipublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Epublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Fpublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Ipublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Lpublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Ipublic.h>
#include <H5Tpublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Ipublic.h>
#include <H5Ppublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Rpublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Spublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <H5Ipublic.h>
#include <H5Tpublic.h>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <half.hpp>
Go to the source code of this file.
++Namespaces | |
namespace | HighFive |
+Typedefs | |
using | HighFive::float16_t = half_float::half |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
#include <highfive/H5Attribute.hpp>
#include <highfive/H5DataSet.hpp>
#include <highfive/H5DataSpace.hpp>
#include <highfive/H5DataType.hpp>
#include <highfive/H5File.hpp>
#include <highfive/H5FileDriver.hpp>
#include <highfive/H5Group.hpp>
#include <highfive/H5PropertyList.hpp>
#include <highfive/H5Reference.hpp>
#include <highfive/H5Selection.hpp>
#include <highfive/H5Utility.hpp>
#include <highfive/H5Version.hpp>
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
Note: In preparation of v3
of HighFive, we've started merging breaking changes into the main branch. More information and opportunity to comment can be found at: https://github.com/BlueBrain/HighFive/issues/864
Documentation: https://bluebrain.github.io/HighFive/
+HighFive is a modern header-only C++11 friendly interface for libhdf5.
+HighFive supports STL vector/string, Boost::UBLAS, Boost::Multi-array and Xtensor. It handles C++ from/to HDF5 with automatic type mapping. HighFive does not require additional libraries (see dependencies).
+It integrates nicely with other CMake projects by defining (and exporting) a HighFive target.
+std::vector
and nested std::vector
from/to any dataset with basic typesstd::string
to/from variable length string datasetstd::byte
in C++17 mode (with -DCMAKE_CXX_STANDARD=17
or higher)Note: As of 2.8.0, one can use highfive/highfive.hpp
to include everything HighFive. Prior to 2.8.0 one would include highfive/H5File.hpp
.
Note: For advanced usecases the dataset can be created without immediately writing to it. This is common in MPI-IO related patterns, or when growing a dataset over the course of a simulation.
+See select_partial_dataset_cpp11.cpp
+See create_attribute_string_integer.cpp
+See src/examples/ subdirectory for more info.
+For several 'standard' use cases the highfive/H5Easy.hpp interface is available. It allows:
+HIGHFIVE_USE_EIGEN
),HIGHFIVE_USE_XTENSOR
).HIGHFIVE_USE_OPENCV
).whereby the int
type of this example can be replaced by any of the above types. See easy_load_dump.cpp for more details.
Note: Classes such as H5Easy::File
are just short for the regular HighFive
classes (in this case HighFive::File
). They can thus be used interchangeably.
There's two common paths of integrating HighFive into a CMake based project. The first is to "vendor" HighFive, the second is to install HighFive as a normal C++ library. Due to how HighFive CMake code works, sometimes following the third Bailout Approach is needed.
+In this approach the HighFive sources are included in a subdirectory of the project (typically as a git submodule), for example in third_party/HighFive
.
The projects CMakeLists.txt
add the following lines
Note: add_subdirectory(third_party/HighFive)
will search and "link" HDF5 and optional dependencies such as Boost.
Alternatively you can install HighFive once and use it in several projects via find_package()
. First one should clone the sources:
By default CMake will install systemwide, which is likely not appropriate. The instruction below allow users to select a custom path where HighFive will be installed, e.g. HIGHFIVE_INSTALL_PREFIX=${HOME}/third_party/HighFive
or some other location. The CMake invocations would be
This will install (i.e. copy) the headers to ${HIGHFIVE_INSTALL_PREFIX}/include
and some CMake files into an appropriate subfolder of ${HIGHFIVE_INSTALL_PREFIX}
.
The projects CMakeLists.txt
should add the following:
Note: If HighFive hasn't been installed in a default location, CMake needs to be told where to find it which can be done by adding -DCMAKE_PREFIX_PATH=${HIGHFIVE_INSTALL_PREFIX}
to the CMake command for building the project using HighFive. The variable CMAKE_PREFIX_PATH
is a semi-colon ;
separated list of directories.
Note: find_package(HighFive)
will search and "link" HDF5 and optional dependencies such as Boost.
Since both add_subdirectory
and find_package
will trigger finding HDF5 and other optional dependencies of HighFive as well as the target_link_libraries
code for "linking" with the dependencies, things can go wrong.
Fortunately, HighFive is a header only library and all that's needed is the headers. Preferably, the version obtained by installing HighFive, since those include H5Version.hpp
. Let's assume they've been copied to third_party/HighFive
. Then one could create a target:
One known case where this is required is when vendoring the optional dependencies of HighFive.
+Do you have questions on how to use HighFive? Would you like to share an interesting example or discuss HighFive features? Head over to the Discussions forum and join the community.
+For bugs and issues please use Issues.
+The development of this software was supported by funding to the Blue Brain Project, a research center of the École polytechnique fédérale de Lausanne (EPFL), from the Swiss government's ETH Board of the Swiss Federal Institutes of Technology.
+Copyright © 2015-2022 Blue Brain Project/EPFL
+Boost Software License 1.0
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ + |
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
+ HighFive 2.9.0
+
+ HighFive - Header-only C++ HDF5 interface
+ |
+
HDF5 file property object. + More...
+ +#include <H5PropertyList.hpp>
HDF5 file property object.
+A property is an object which is expected to have a method with the following signature void apply(hid_t hid) const