file.hpp

Go to the documentation of this file.

//
// (c) Copyright 2017 DESY,ESS
//
// This file is part of h5cpp.
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
// License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the
// Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor
// Boston, MA  02110-1301 USA
// ===========================================================================
//
// Authors:
//   Eugen Wintersberger <eugen.wintersberger@desy.de>
//   Jan Kotanski <jan.kotanski@desy.de>
// Created on: Sep 8, 2017
//
#pragma once
 
#include <h5cpp/file/types.hpp>
#include <h5cpp/core/filesystem.hpp>
#include <h5cpp/core/windows.hpp>
#include <h5cpp/core/object_handle.hpp>
#include <h5cpp/core/object_id.hpp>
#include <h5cpp/property/group_access.hpp>
#include <h5cpp/dataspace/dataspace.hpp>
#include <h5cpp/dataspace/type_trait.hpp>
#include <h5cpp/datatype/factory.hpp>
#include <h5cpp/error/error.hpp>
#include <h5cpp/core/utilities.hpp>
 
 
namespace hdf5 {
namespace node {
class Group;
}
}
 
namespace hdf5 {
namespace file {
 
class DLL_EXPORT File
{
 public:
  File() = default;
 
  File(const File &) = default;
 
  File(File &&) = default;
 
  explicit File(ObjectHandle &&handle);
 
  File &operator=(const File &) = default;
 
  AccessFlags intent() const;
 
  size_t size() const;
 
  ssize_t buffer_size() const;
 
  void flush(Scope scope) const;
 
  void close();
 
  fs::path path() const;
 
  size_t count_open_objects(SearchFlags flag) const;
  size_t count_open_objects(SearchFlagsBase flags) const;
 
  node::Group root(const property::GroupAccessList &gapl = property::GroupAccessList()) const;
 
  explicit operator hid_t() const
  {
    return static_cast<hid_t>(handle_);
  }
 
  template<typename T>
  size_t to_buffer(T &data) const;
 
  template<typename T>
   size_t to_buffer_reshape(T &data,
                const datatype::Datatype &mem_type,
                const dataspace::Dataspace &mem_space) const;
 
  bool is_valid() const;
 
  ObjectId id() const;
 
 private:
  ObjectHandle handle_; 
 
};
 
template<typename T>
size_t File::to_buffer(T &data) const
{
  auto mem_space = hdf5::dataspace::create(data);
  hdf5::datatype::DatatypeHolder mem_type_holder;
  return to_buffer_reshape(data, mem_type_holder.get(data), mem_space);
}
 
template<typename T>
size_t File::to_buffer_reshape(T &data,
                   const datatype::Datatype &mem_type,
                   const dataspace::Dataspace &mem_space) const
{
  size_t databytesize = signed2unsigned<hsize_t>(mem_space.size()) * mem_type.size();
  ssize_t s = 0;
  if(mem_type.get_class() == datatype::Class::Integer)
    {
      flush(Scope::Global);
      s = H5Fget_file_image(static_cast<hid_t>(*this), dataspace::ptr(data), databytesize);
      if (s < 0)
    {
      error::Singleton::instance().throw_with_stack("Failure retrieving the image buffer to to small dataspace");
        }
    }
  else
    {
      std::stringstream ss;
      ss<<"Failure retrieving the image buffer to non-integer dataspace";
      error::Singleton::instance().throw_with_stack(ss.str());
    }
  return static_cast<hsize_t>(s);
}
 
 
} // namespace file
} // namespace hdf5