H5File.hpp

/*
 *  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 "bits/H5Annotate_traits.hpp"
#include "bits/H5Node_traits.hpp"
 
namespace h5gt {
 
class File : public Object,
    public NodeTraits<File>,
    public AnnotateTraits<File> {
public:
 
  // this makes available to use both
  // Object::getObjectType and NodeTraits<T>::getObjectType
  using Object::getObjectType;
  using NodeTraits<File>::getObjectType;
 
  const static ObjectType type = ObjectType::File;
 
  enum OpenFlag: 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());
 
  bool operator==(const File& other) const;
  bool operator!=(const File& other) const;
 
  static File FromId(const hid_t& id, const bool& increaseRefCount = false){
    Object obj = Object(id, ObjectType::File, increaseRefCount);
    return File(obj);
  };
 
protected:
  File(const Object& obj) : Object(obj){};
};
 
}  // namespace h5gt
 
// 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