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)
 *
 */
#ifndef H5FILE_HPP
#define H5FILE_HPP
 
#include <string>
 
#include "H5FileDriver.hpp"
#include "H5Object.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 : unsigned {
        ReadOnly = 0x00u,
        ReadWrite = 0x01u,
        Truncate = 0x02u,
        Excl = 0x04u,
        Debug = 0x08u,
        Create = 0x10u,
        Overwrite = Truncate,
        OpenOrCreate = ReadWrite | Create
    };
 
    explicit File(const std::string& filename, unsigned openFlags = ReadOnly,
                  const FileAccessProps& fileAccessProps = FileDriver());
 
    const std::string& getName() const noexcept;
 
    void flush();
 
 private:
    std::string _filename;
};
 
}  // 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"
 
#endif  // H5FILE_HPP