functions.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
// ===========================================================================
//
// Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
// Author: Martin Shetty <martin.shetty@esss.se>
// Created on: Sep 14, 2017
//
#pragma once

#include <h5cpp/node/node.hpp>
#include <h5cpp/node/group.hpp>
#include <h5cpp/node/dataset.hpp>
#include <h5cpp/core/path.hpp>
#include <h5cpp/property/link_creation.hpp>
#include <h5cpp/property/link_access.hpp>
#include <h5cpp/property/object_copy.hpp>
#include <h5cpp/core/windows.hpp>

namespace hdf5 {
namespace node {

DLL_EXPORT void copy(const Node &source,
                     const Group &base,
                     const Path &relative_path,
                     const property::ObjectCopyList &ocpl = property::ObjectCopyList(),
                     const property::LinkCreationList &lcpl = property::LinkCreationList());

DLL_EXPORT void copy(const Node &source,
                     const Group &destination,
                     const property::ObjectCopyList &ocpl = property::ObjectCopyList(),
                     const property::LinkCreationList &lcpl = property::LinkCreationList());

DLL_EXPORT void move(const Node &source,
                     const Group &base,
                     const Path &relative_path,
                     const property::LinkCreationList &lcpl = property::LinkCreationList(),
                     const property::LinkAccessList &lapl = property::LinkAccessList());

DLL_EXPORT void move(const Node &source,
                     const Group &destination,
                     const property::LinkCreationList &lcpl = property::LinkCreationList(),
                     const property::LinkAccessList &lapl = property::LinkAccessList());

DLL_EXPORT void remove(const Group &base,
                       const Path &object_path,
                       const property::LinkAccessList &lapl = property::LinkAccessList());

DLL_EXPORT void remove(const Node &object,
                       const property::LinkAccessList &lapl = property::LinkAccessList());

DLL_EXPORT void link(const Node &target,
                     const Group &link_base,
                     const Path &link_path,
                     const property::LinkCreationList &lcpl = property::LinkCreationList(),
                     const property::LinkAccessList &lapl = property::LinkAccessList());


DLL_EXPORT void link(const Path &target_path,
                     const Group &link_base,
                     const Path &link_path,
                     const property::LinkCreationList &lcpl = property::LinkCreationList(),
                     const property::LinkAccessList &lapl = property::LinkAccessList());

DLL_EXPORT void link(const boost::filesystem::path &target_file,
                     const Path &target_path,
                     const Group &link_base,
                     const Path &link_path,
                     const property::LinkCreationList &lcpl = property::LinkCreationList(),
                     const property::LinkAccessList &lapl = property::LinkAccessList());

DLL_EXPORT Node get_node(const Group &base,
                         const Path &node_path,
                         const property::LinkAccessList &lapl = property::LinkAccessList());


DLL_EXPORT Group get_real_base(const Group &base, const Path &path,
                               const property::LinkAccessList &lapl = property::LinkAccessList());

DLL_EXPORT Group get_group(const Group &base,
                           const Path &path,
                           const property::LinkAccessList &lapl = property::LinkAccessList());
DLL_EXPORT Dataset get_dataset(const Group &base,
                               const Path &path,
                               const property::LinkAccessList &lapl = property::LinkAccessList());


DLL_EXPORT bool is_group(const Node &node);

DLL_EXPORT bool is_dataset(const Node &node);

} // namespace node
} // namespace hdf5