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

#include <h5cpp/property/property_list.hpp>

namespace hdf5 {
namespace property {

class CopyFlags;

enum class CopyFlag : unsigned {
  SHALLOW_HIERARCHY = H5O_COPY_SHALLOW_HIERARCHY_FLAG,
  EXPAND_SOFT_LINKS = H5O_COPY_EXPAND_SOFT_LINK_FLAG,
  EXPAND_EXTERNAL_LINKS = H5O_COPY_EXPAND_EXT_LINK_FLAG,
  EXPAND_REFERENCES = H5O_COPY_EXPAND_REFERENCE_FLAG,
  WITHOUT_ATTRIBUTES = H5O_COPY_WITHOUT_ATTR_FLAG,
  MERGE_COMMITTED_TYPES = H5O_COPY_MERGE_COMMITTED_DTYPE_FLAG
};

DLL_EXPORT std::ostream &operator<<(std::ostream &stream, const CopyFlag &flag);

DLL_EXPORT CopyFlags operator|(const CopyFlag &lhs, const CopyFlag &rhs);

class DLL_EXPORT CopyFlags {
 private:
  unsigned value_;
 public:
  CopyFlags() noexcept;

  explicit CopyFlags(unsigned flags) noexcept;

  CopyFlags(const CopyFlags &flags) = default;

  CopyFlags &operator|=(const CopyFlag &flag) noexcept;

  CopyFlags &operator|=(const CopyFlags &flags) noexcept;

  explicit operator unsigned() const noexcept {
    return value_;
  }

  bool shallow_hierarchy() const noexcept;

  void shallow_hierarchy(bool flag) noexcept;

  bool expand_soft_links() const noexcept;

  void expand_soft_links(bool flag) noexcept;

  bool expand_external_links() const noexcept;

  void expand_external_links(bool flag) noexcept;

  bool expand_references() const noexcept;

  void expand_references(bool flag) noexcept;

  bool without_attributes() const noexcept;

  void without_attributes(bool flag) noexcept;

  bool merge_committed_types() const noexcept;

  void merge_committed_types(bool flag) noexcept;

};

DLL_EXPORT CopyFlags operator|(const CopyFlags &flags, const CopyFlags &rhs) noexcept;

DLL_EXPORT CopyFlags operator|(const CopyFlags &flags, const CopyFlag &flag) noexcept;

DLL_EXPORT CopyFlags operator|(const CopyFlag &flag, const CopyFlags &flags) noexcept;

class DLL_EXPORT ObjectCopyList : public List {
 public:
  ObjectCopyList();

  explicit ObjectCopyList(ObjectHandle &&handle);

  void flags(const CopyFlags &flags) const;
  void flags(const CopyFlag &flag) const;

  CopyFlags flags() const;

};

} // namespace property
} // namespace hdf5