file_creation.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>
//   Martin Shetty <martin.shetty@esss.se>
// Created on: Aug 18, 2017
//
#pragma once

#include <h5cpp/property/group_creation.hpp>
#include <h5cpp/core/windows.hpp>

namespace hdf5 {
namespace property {

class DLL_EXPORT FileCreationList : public GroupCreationList {
 public:
  FileCreationList();
  ~FileCreationList();

  explicit FileCreationList(ObjectHandle &&handle);

  void user_block(hsize_t size) const;
  hsize_t user_block() const;

  void object_offset_size(size_t size) const;
  size_t object_offset_size() const;

  void object_length_size(size_t size) const;
  size_t object_length_size() const;

  void btree_rank(unsigned int ik);
  unsigned int btree_rank() const;

  void btree_symbols(unsigned int lk);
  unsigned int btree_symbols() const;

  void chunk_tree_rank(unsigned int ik);
  unsigned int chunk_tree_rank() const;

#if H5_VERSION_GE(1, 10, 1)
  void page_size(hsize_t size);
  hsize_t page_size() const;
#endif

// The following still need wrapping
//    H5Pset_file_space_strategy
//    H5Pget_file_space_strategy
//
//    H5Pset_shared_mesg_nindexes
//    H5Pget_shared_mesg_nindexes
//
//    H5Pset_shared_mesg_index
//    H5Pget_shared_mesg_index
//
//    H5Pset_shared_mesg_phase_change
//    H5Pget_shared_mesg_phase_change

// DO NOT WRAP the following:
//    H5Pget_version -- deprecated in favor of H5Fget_info

};

} // namespace property
} // namespace hdf5