h5::Version Class Reference

Used to store the version of the file. More...

#include <Version.hpp>

Public Member Functions
uint32_t	get_version () const
const std::string &	subfile_path () const override
	Return the path to the subfile where this object is stored. More...
virtual const std::string &	subfile_path () const =0
	Return the path to the subfile where this object is stored. More...

Detailed Description

Used to store the version of the file.

A Version object should be stored inside each H5 object that is to represent a file, e.g. Dat, or Text.

Example

To write the version use:

    h5::H5File<h5::AccessType::ReadWrite> my_file(h5_file_name);
    my_file.insert<h5::Version>("/the_version", version_number);

To read the version use:

  const auto& const_version = my_file.get<h5::Version>("/the_version");

Member Function Documentation

subfile_path()

const std::string & h5::Version::subfile_path ( ) const

inlineoverridevirtual

Return the path to the subfile where this object is stored.

Implements h5::Object.

---

The documentation for this class was generated from the following file:

• src/IO/H5/Version.hpp