group.hpp

Go to the documentation of this file.

// Copyright (c) 2019-2024 Simons Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0.txt
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Authors: Thomas Hahn, Henri Menke, Olivier Parcollet, Nils Wentzell

 
#ifndef LIBH5_GROUP_HPP
#define LIBH5_GROUP_HPP
 
#include "./file.hpp"
 
#include <string>
#include <utility>
#include <vector>
 
namespace h5 {

  class group : public object {
    // File to which the group belongs.
    file parent_file;
 
    public:
    group() = default;

    group(file f);
 
    private:
    // Copy the given object and parent file (only used internally to open/create a subgroup).
    group(object obj, file _parent_file) : object{obj}, parent_file{std::move(_parent_file)} {}
 
    public:
    [[nodiscard]] std::string name() const;

    [[nodiscard]] file get_file() const { return parent_file; }

    [[nodiscard]] bool has_key(std::string const &key) const;

    [[nodiscard]] bool has_subgroup(std::string const &key) const;

    [[nodiscard]] bool has_dataset(std::string const &key) const;

    void unlink(std::string const &key, bool error_if_absent = false) const;

    [[nodiscard]] group open_group(std::string const &key) const;

    group create_group(std::string const &key, bool delete_if_exists = true) const;

    void create_softlink(std::string const &target_key, std::string const &key, bool delete_if_exists = true) const;

    [[nodiscard]] dataset open_dataset(std::string const &key) const;

    dataset create_dataset(std::string const &key, datatype ty, dataspace sp, hid_t pl) const;

    dataset create_dataset(std::string const &key, datatype ty, dataspace sp) const;

    [[nodiscard]] std::vector<std::string> get_all_subgroup_names() const;

    [[nodiscard]] std::vector<std::string> get_all_dataset_names() const;

    [[nodiscard]] std::vector<std::string> get_all_subgroup_dataset_names() const;

    [[nodiscard]] std::vector<std::string> keys() const { return get_all_subgroup_dataset_names(); }

    void write_attribute(std::string const &name, std::string const &s) const;

    [[nodiscard]] std::string read_attribute(std::string const &name) const;

    [[nodiscard]] std::string read_hdf5_format_from_key(std::string const &key) const;
  };
 
} // namespace h5
 
#endif // LIBH5_GROUP_HPP