group.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: Aug 24, 2017
//
#pragma once

#include <h5cpp/node/node.hpp>
#include <h5cpp/node/link_view.hpp>
#include <h5cpp/node/node_view.hpp>
#include <h5cpp/node/dataset.hpp>
#include <h5cpp/core/iterator_config.hpp>
#include <h5cpp/property/link_creation.hpp>
#include <h5cpp/property/group_creation.hpp>
#include <h5cpp/property/group_access.hpp>
#include <h5cpp/property/dataset_creation.hpp>
#include <h5cpp/property/dataset_access.hpp>
#include <h5cpp/property/object_copy.hpp>
#include <h5cpp/dataspace/dataspace.hpp>
#include <h5cpp/datatype/datatype.hpp>


namespace hdf5 {
namespace node {

class DLL_EXPORT Group : public Node
{
  public:
    LinkView      links;
    NodeView      nodes;

    Group();

    Group(const Group &group);

    Group(const Node &node);

    Group(const Group &parent,const Path &path,
          const property::LinkCreationList &lcpl = property::LinkCreationList(),
          const property::GroupCreationList &gcpl = property::GroupCreationList(),
          const property::GroupAccessList &gapl = property::GroupAccessList());

    Group &operator=(const Group &group);

    void flush() const;

    IteratorConfig &iterator_config() noexcept
    {
      return iter_config_;
    }

    const IteratorConfig &iterator_config() const noexcept
    {
      return iter_config_;
    }

    bool exists(const std::string &name,
                const property::LinkAccessList &lapl = property::LinkAccessList()) const;


    Group create_group(const std::string &name,
                       const property::LinkCreationList &lcpl = property::LinkCreationList(),
                       const property::GroupCreationList &gcpl = property::GroupCreationList(),
                       const property::GroupAccessList &gapl = property::GroupAccessList()) const;

    Dataset create_dataset(const std::string &name,
                           const datatype::Datatype &type,
                           const dataspace::Dataspace &space,
                           const property::DatasetCreationList &dcpl = property::DatasetCreationList(),
                           const property::LinkCreationList &lcpl = property::LinkCreationList(),
                           const property::DatasetAccessList &dapl = property::DatasetAccessList()
                           ) const;


    Node operator[](const Path &path) const;

    void create_link(const Path &link_path,
                     const fs::path &target_file,
                     const Path &target_path,
                     const property::LinkCreationList &lcpl = property::LinkCreationList(),
                     const property::LinkAccessList &lapl = property::LinkAccessList());

    void create_link(const Path &link_path,
                     const Path &target_path,
                     const property::LinkCreationList &lcpl = property::LinkCreationList(),
                     const property::LinkAccessList &lapl = property::LinkAccessList());

    void create_link(const Path &link_path,
                     const Node &target,
                     const property::LinkCreationList &lcpl = property::LinkCreationList(),
                     const property::LinkAccessList &lapl = property::LinkAccessList());

    void copy_here(const Path &link_path,
                   const Node &target,
                   const property::ObjectCopyList &ocpl = property::ObjectCopyList(),
                   const property::LinkCreationList &lcpl = property::LinkCreationList());

    void copy_here(const Node &target,
                   const property::ObjectCopyList &ocpl = property::ObjectCopyList(),
                   const property::LinkCreationList &lcpl = property::LinkCreationList());

    void move_here(const Path &link_path,
                   const Node &target,
                   const property::LinkCreationList &lcpl = property::LinkCreationList(),
                   const property::LinkAccessList &lapl = property::LinkAccessList());

    void move_here(const Node &target,
                   const property::LinkCreationList &lcpl = property::LinkCreationList(),
                   const property::LinkAccessList &lapl = property::LinkAccessList());

    void remove(const Path &path,
                const property::LinkAccessList &lapl = property::LinkAccessList());


    bool has_group(const Path &path,
                   const property::LinkAccessList &lapl = property::LinkAccessList()) const noexcept;

    bool has_dataset(const Path &path,
                     const property::LinkAccessList &lapl = property::LinkAccessList()) const noexcept;


    Group get_group(const Path &path,
                    const property::LinkAccessList &lapl = property::LinkAccessList()) const;

    Dataset get_dataset(const Path &path,
                        const property::LinkAccessList &lapl = property::LinkAccessList()) const;


 private:
    IteratorConfig iter_config_;

};



} // namespace node
} // namespace hdf5