H5File.hpp

Go to the documentation of this file.

/*
 *  Copyright (c), 2017, Adrien Devresse <adrien.devresse@epfl.ch>
 *
 *  Distributed under the Boost Software License, Version 1.0.
 *    (See accompanying file LICENSE_1_0.txt or copy at
 *          http://www.boost.org/LICENSE_1_0.txt)
 *
 */
#pragma once
 
#include <string>
#include <type_traits>
 
#include "H5Object.hpp"
#include "H5PropertyList.hpp"
#include "bits/H5Annotate_traits.hpp"
#include "bits/H5Node_traits.hpp"
 
namespace HighFive {
 
 
class File: public Object, public NodeTraits<File>, public AnnotateTraits<File> {
  public:
    const static ObjectType type = ObjectType::File;
 
    enum class AccessMode {
        None = 0x00u,
        ReadOnly = 0x01u,
        ReadWrite = 0x02u,
        Truncate = 0x04u,
        Excl = 0x08u,
        Debug = 0x10u,
        Create = 0x20u,
        ReadSWMR = 0x40u,
        WriteSWMR = 0x80u,
        Overwrite = Truncate,
        OpenOrCreate = ReadWrite | Create
    };
 
    constexpr static AccessMode ReadOnly = AccessMode::ReadOnly;
    constexpr static AccessMode ReadWrite = AccessMode::ReadWrite;
    constexpr static AccessMode Truncate = AccessMode::Truncate;
    constexpr static AccessMode Excl = AccessMode::Excl;
    constexpr static AccessMode Debug = AccessMode::Debug;
    constexpr static AccessMode Create = AccessMode::Create;
    constexpr static AccessMode Overwrite = AccessMode::Overwrite;
    constexpr static AccessMode OpenOrCreate = AccessMode::OpenOrCreate;
    constexpr static AccessMode ReadSWMR = AccessMode::ReadSWMR;
    constexpr static AccessMode WriteSWMR = AccessMode::WriteSWMR;
 
    explicit File(const std::string& filename,
                  AccessMode openFlags = ReadOnly,
                  const FileAccessProps& fileAccessProps = FileAccessProps::Default());
 
    File(const std::string& filename,
         AccessMode access_mode,
         const FileCreateProps& fileCreateProps,
         const FileAccessProps& fileAccessProps = FileAccessProps::Default());
 
    File(File&& other) noexcept = default;
 
    File& operator=(File&& other) = default;
 
    File(const File& other) = default;
 
    File& operator=(const File& other) = default;
 
    const std::string& getName() const;
 
    std::string getPath() const noexcept {
        return "/";
    }
 
    hsize_t getMetadataBlockSize() const;
 
    std::pair<H5F_libver_t, H5F_libver_t> getVersionBounds() const;
 
#if H5_VERSION_GE(1, 10, 1)
    H5F_fspace_strategy_t getFileSpaceStrategy() const;
 
    hsize_t getFileSpacePageSize() const;
#endif
 
    void flush();
 
#if H5_VERSION_GE(1, 10, 0)
    void startSWMRWrite();
#endif
 
    FileCreateProps getCreatePropertyList() const {
        return details::get_plist<FileCreateProps>(*this, H5Fget_create_plist);
    }
 
    FileAccessProps getAccessPropertyList() const {
        return details::get_plist<FileAccessProps>(*this, H5Fget_access_plist);
    }
 
    size_t getFileSize() const;
 
    size_t getFreeSpace() const;
 
  protected:
    File() = default;
    using Object::Object;
 
  private:
    mutable std::string _filename{};
 
    template <typename>
    friend class PathTraits;
};
 
inline File::AccessMode operator|(File::AccessMode lhs, File::AccessMode rhs) {
    using int_t = std::underlying_type<File::AccessMode>::type;
    return static_cast<File::AccessMode>(static_cast<int_t>(lhs) | static_cast<int_t>(rhs));
}
 
inline File::AccessMode operator&(File::AccessMode lhs, File::AccessMode rhs) {
    using int_t = std::underlying_type<File::AccessMode>::type;
    return static_cast<File::AccessMode>(static_cast<int_t>(lhs) & static_cast<int_t>(rhs));
}
 
inline File::AccessMode operator^(File::AccessMode lhs, File::AccessMode rhs) {
    using int_t = std::underlying_type<File::AccessMode>::type;
    return static_cast<File::AccessMode>(static_cast<int_t>(lhs) ^ static_cast<int_t>(rhs));
}
 
inline File::AccessMode operator~(File::AccessMode mode) {
    using int_t = std::underlying_type<File::AccessMode>::type;
    return static_cast<File::AccessMode>(~static_cast<int_t>(mode));
}
 
inline const File::AccessMode& operator|=(File::AccessMode& lhs, File::AccessMode rhs) {
    lhs = lhs | rhs;
    return lhs;
}
 
inline File::AccessMode operator&=(File::AccessMode& lhs, File::AccessMode rhs) {
    lhs = lhs & rhs;
    return lhs;
}
 
inline File::AccessMode operator^=(File::AccessMode& lhs, File::AccessMode rhs) {
    lhs = lhs ^ rhs;
    return lhs;
}
 
inline bool any(File::AccessMode mode) {
    return mode != File::AccessMode::None;
}
 
 
}  // namespace HighFive
 
// H5File is the main user constructible -> bring in implementation headers
#include "bits/H5Annotate_traits_misc.hpp"
#include "bits/H5File_misc.hpp"
#include "bits/H5Node_traits_misc.hpp"
#include "bits/H5Path_traits_misc.hpp"