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:
    static const int ReadOnly = 0x00;
    static const int ReadWrite = 0x01;
    static const int Truncate = 0x02;
    static const int Excl = 0x04;
    static const int Debug = 0x08;
    static const int Create = 0x10;
    static const int Overwrite = Truncate;
    static const int OpenOrCreate = ReadWrite | Create;


    explicit File(const std::string& filename, int openFlags = ReadOnly,
                  const Properties& fileAccessProps = FileDriver());

    const std::string& getName() const;

    void flush();

 private:
    std::string _filename;
};
}  // namespace HighFive

#include "bits/H5File_misc.hpp"

#endif  // H5FILE_HPP