functions.hpp

Go to the documentation of this file.

//
// (c) Copyright 2017 DESY,ESS
//
// This file is part of h5pp.
//
// 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/core/filesystem.hpp>
#include <h5cpp/file/file.hpp>
#include <h5cpp/file/types.hpp>
#include <h5cpp/property/file_creation.hpp>
#include <h5cpp/property/file_access.hpp>
#include <h5cpp/core/windows.hpp>
#include <h5cpp/dataspace/dataspace.hpp>
#include <h5cpp/dataspace/type_trait.hpp>
#include <h5cpp/datatype/factory.hpp>
#include <h5cpp/error/error.hpp>


namespace hdf5 {
namespace file {

DLL_EXPORT File create(const fs::path &path,
                       AccessFlags flags = AccessFlags::EXCLUSIVE,
                       const property::FileCreationList &fcpl = property::FileCreationList(),
                       const property::FileAccessList &fapl = property::FileAccessList());
DLL_EXPORT File create(const fs::path &path,
                       AccessFlagsBase flags,
                       const property::FileCreationList &fcpl = property::FileCreationList(),
                       const property::FileAccessList &fapl = property::FileAccessList());

DLL_EXPORT File open(const fs::path &path,
                     AccessFlags flags = AccessFlags::READONLY,
                     const property::FileAccessList &fapl = property::FileAccessList());
DLL_EXPORT File open(const fs::path &path,
                     AccessFlagsBase flags,
                     const property::FileAccessList &fapl = property::FileAccessList());

DLL_EXPORT bool is_hdf5_file(const fs::path &path);

template<typename T>
File from_buffer(T &data,
         ImageFlags flags = ImageFlags::READONLY);
template<typename T>
File from_buffer(T &data,
         ImageFlagsBase flags);

template<typename T>
File from_buffer(const T &data,
         ImageFlags flags = ImageFlags::READONLY);
template<typename T>
File from_buffer(const T &data,
         ImageFlagsBase flags);



template<typename T>
File from_buffer(T &data, ImageFlags flags)
{
  return from_buffer(data, static_cast<ImageFlagsBase>(flags));
}

template<typename T>
File from_buffer(const T &data, ImageFlags flags)
{
  return from_buffer(data, static_cast<ImageFlagsBase>(flags));
}

template<typename T>
File from_buffer(const T &data, ImageFlagsBase flags)
{
  if((flags & static_cast<AccessFlagsBase>(ImageFlags::READWRITE))  &&
     (flags & static_cast<AccessFlagsBase>(ImageFlags::DONT_COPY)))
    throw std::runtime_error("Invalid ImageFlags for const buffer");
  return from_buffer(const_cast<T&>(data), static_cast<ImageFlagsBase>(flags));
}

template<typename T>
File from_buffer(T &data, ImageFlagsBase flags)
{
  auto memory_space = hdf5::dataspace::create(data);
  auto memory_type  = hdf5::datatype::create(data);
  size_t databytesize = memory_space.size() * memory_type.size();
  hid_t fid = 0;
  if(memory_type.get_class() == datatype::Class::INTEGER)
    {

      fid = H5LTopen_file_image(dataspace::ptr(data), databytesize, flags);
      if (fid < 0)
    {
      std::stringstream ss;
      ss << "Failure opening file image";
      error::Singleton::instance().throw_with_stack(ss.str());
    }
      return File(ObjectHandle(fid));
    }
  else
    {
      std::stringstream ss;
      ss<<"Failure to open non-integer buffer";
      error::Singleton::instance().throw_with_stack(ss.str());
    }
  return File(hdf5::ObjectHandle(fid));
}

} // namespace file
} // namespace hdf5