|
MGIS 3.1.0
|
#include <span>#include <string>#include <vector>#include <H5Cpp.h>#include "MGIS/Config.hxx"#include "MGIS/Context.hxx"#include "MGIS/Utilities/HDF5Forward.hxx"Namespaces | |
| namespace | mgis |
| the namespace mgis encloses all the MGIS project. | |
Functions | |
| template<typename T> | |
| H5::PredType | mgis::utilities::hdf5::getNativeType () MGIS_NOEXCEPT |
| template<> | |
| MGIS_EXPORT MGIS_NODISCARD H5::PredType | mgis::utilities::hdf5::getNativeType< float > () MGIS_NOEXCEPT |
| template<> | |
| MGIS_EXPORT MGIS_NODISCARD H5::PredType | mgis::utilities::hdf5::getNativeType< double > () MGIS_NOEXCEPT |
| template<> | |
| MGIS_EXPORT MGIS_NODISCARD H5::PredType | mgis::utilities::hdf5::getNativeType< long double > () MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::exists (const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| check if an object with the given path exists in the given group | |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::subGroupExists (const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| check if a group with the given path exists in the given given | |
| MGIS_EXPORT MGIS_NODISCARD std::optional< H5::Group > | mgis::utilities::hdf5::createGroup (Context &, const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| create a new group | |
| MGIS_EXPORT MGIS_NODISCARD std::optional< H5::Group > | mgis::utilities::hdf5::openGroup (Context &, const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| open a new group | |
| MGIS_EXPORT MGIS_NODISCARD std::optional< H5::DataSet > | mgis::utilities::hdf5::openDataSet (Context &ctx, const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| open a data set | |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::removeDataSet (Context &, const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| remove a data set | |
| MGIS_EXPORT MGIS_NODISCARD std::optional< std::vector< std::string > > | mgis::utilities::hdf5::getSubGroupNames (Context &, const H5::Group &, const bool) MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::getSubGroupNames (Context &, std::vector< std::string > &, const H5::Group &, const bool) MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD std::optional< std::vector< std::string > > | mgis::utilities::hdf5::getDataSetNames (Context &, const H5::Group &) MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD std::optional< bool > | mgis::utilities::hdf5::contains (Context &, const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::unlinkIfExists (Context &, const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| delete an existing group or dataset if it exists | |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::write (Context &, H5::Group &, const std::string &, const real &, const bool) MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::read (Context &, real &, const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::write (Context &, H5::Group &, const std::string &, std::span< const real >, const bool) MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::read (Context &, std::vector< real > &, const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD bool | mgis::utilities::hdf5::read (Context &, std::span< real >, const H5::Group &, const std::string &) MGIS_NOEXCEPT |
| MGIS_EXPORT MGIS_NODISCARD InvalidResult | mgis::utilities::hdf5::registerH5ExceptionInErrorBacktrace (ErrorBacktrace &) MGIS_NOEXCEPT |
| a custom Lippincott-like function that extract error messages from a standard exception or an exception generated by the HD5 library | |
| MGIS_EXPORT MGIS_NODISCARD InvalidResult | mgis::utilities::hdf5::registerH5ExceptionInErrorBacktraceWithoutSourceLocation (ErrorBacktrace &) MGIS_NOEXCEPT |
| a custom Lippincott-like function that extract error messages from a standard exception or an exception generated by the HD5 library | |
| MGIS_EXPORT MGIS_NODISCARD std::optional< bool > mgis::utilities::hdf5::contains | ( | Context & | , |
| const H5::Group & | , | ||
| const std::string & | ) |
| [in,out] | ctx | execution context |
| [in] | g | group |
| [in] | n | name |
| MGIS_EXPORT MGIS_NODISCARD std::optional< H5::Group > mgis::utilities::hdf5::createGroup | ( | Context & | , |
| const H5::Group & | , | ||
| const std::string & | ) |
create a new group
| [in,out] | ctx | execution context |
| [in] | g | parent group |
| [in] | n | group name |
| MGIS_EXPORT MGIS_NODISCARD bool mgis::utilities::hdf5::exists | ( | const H5::Group & | , |
| const std::string & | ) |
check if an object with the given path exists in the given group
| [in] | g | group |
| [in] | p | path |
| MGIS_EXPORT MGIS_NODISCARD std::optional< std::vector< std::string > > mgis::utilities::hdf5::getDataSetNames | ( | Context & | , |
| const H5::Group & | ) |
| [in,out] | ctx | execution context |
| [in] | g | group |
| MGIS_EXPORT MGIS_NODISCARD std::optional< std::vector< std::string > > mgis::utilities::hdf5::getSubGroupNames | ( | Context & | , |
| const H5::Group & | , | ||
| const bool | ) |
| [in] | g | group |
| [in] | b | boolean allowing other objects than groups to be inside the given group |
| MGIS_EXPORT MGIS_NODISCARD bool mgis::utilities::hdf5::getSubGroupNames | ( | Context & | , |
| std::vector< std::string > & | , | ||
| const H5::Group & | , | ||
| const bool | ) |
| [in,out] | ctx | execution context |
| [out] | n | names |
| [in] | g | group |
| [in] | b | boolean allowing other objects than groups to be inside the given group |
| MGIS_EXPORT MGIS_NODISCARD std::optional< H5::DataSet > mgis::utilities::hdf5::openDataSet | ( | Context & | ctx, |
| const H5::Group & | , | ||
| const std::string & | ) |
open a data set
| [in,out] | ctx | execution context |
| [in] | g | parent group |
| [in] | n | data set name |
| MGIS_EXPORT MGIS_NODISCARD std::optional< H5::Group > mgis::utilities::hdf5::openGroup | ( | Context & | , |
| const H5::Group & | , | ||
| const std::string & | ) |
open a new group
| [in,out] | ctx | execution context |
| [in] | g | parent group |
| [in] | n | group name |
| MGIS_EXPORT MGIS_NODISCARD bool mgis::utilities::hdf5::read | ( | Context & | , |
| real & | , | ||
| const H5::Group & | , | ||
| const std::string & | ) |
| [in,out] | ctx | execution context |
| [out] | o | : object to be written |
| g | : HDF5 group | |
| n | : name of the dataset |
| MGIS_EXPORT MGIS_NODISCARD bool mgis::utilities::hdf5::read | ( | Context & | , |
| std::span< real > | , | ||
| const H5::Group & | , | ||
| const std::string & | ) |
| [in,out] | ctx | execution context |
| [out] | o | : object to be read |
| g | : HDF5 group | |
| n | : name of the dataset |
| MGIS_EXPORT MGIS_NODISCARD bool mgis::utilities::hdf5::read | ( | Context & | , |
| std::vector< real > & | , | ||
| const H5::Group & | , | ||
| const std::string & | ) |
| [in,out] | ctx | execution context |
| [out] | o | : object to be read |
| g | : HDF5 group | |
| n | : name of the dataset |
| MGIS_EXPORT MGIS_NODISCARD InvalidResult mgis::utilities::hdf5::registerH5ExceptionInErrorBacktrace | ( | ErrorBacktrace & | ) |
a custom Lippincott-like function that extract error messages from a standard exception or an exception generated by the HD5 library
| [out] | e | error back trace handler |
| [in] | l | description of the call site |
| MGIS_EXPORT MGIS_NODISCARD InvalidResult mgis::utilities::hdf5::registerH5ExceptionInErrorBacktraceWithoutSourceLocation | ( | ErrorBacktrace & | ) |
a custom Lippincott-like function that extract error messages from a standard exception or an exception generated by the HD5 library
| [out] | e | error back trace handler |
| MGIS_EXPORT MGIS_NODISCARD bool mgis::utilities::hdf5::removeDataSet | ( | Context & | , |
| const H5::Group & | , | ||
| const std::string & | ) |
remove a data set
| [in,out] | ctx | execution context |
| [in] | g | parent group |
| [in] | n | data set name |
| MGIS_EXPORT MGIS_NODISCARD bool mgis::utilities::hdf5::subGroupExists | ( | const H5::Group & | , |
| const std::string & | ) |
check if a group with the given path exists in the given given
| [in] | g | group |
| [in] | p | path |
| MGIS_EXPORT MGIS_NODISCARD bool mgis::utilities::hdf5::unlinkIfExists | ( | Context & | , |
| const H5::Group & | , | ||
| const std::string & | ) |
delete an existing group or dataset if it exists
| [in,out] | ctx | execution context |
| [in] | g | parent group |
| [in] | n | group or dataset name |
| MGIS_EXPORT MGIS_NODISCARD bool mgis::utilities::hdf5::write | ( | Context & | , |
| H5::Group & | , | ||
| const std::string & | , | ||
| const real & | , | ||
| const bool | ) |
| [in,out] | ctx | execution context |
| g | : HDF5 group | |
| n | : name of the dataset | |
| o | : object to be written | |
| [in] | b | allow overwrite |