object.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, Olivier Parcollet, Nils Wentzell
 
#ifndef LIBH5_OBJECT_HPP
#define LIBH5_OBJECT_HPP
 
#include "./utils.hpp"
 
#include <string>
 
namespace h5 {
 
  class object {
    protected:
    // Wrapped HDF5 ID.
    hid_t id = 0; // NOLINT (protected member is wanted here)
 
    public:
    [[nodiscard]] static object from_borrowed(hid_t id);
 
    object(hid_t id = 0) : id(id) {}
 
    object(object const &x);
 
    object(object &&x) noexcept : id(x.id) { x.id = 0; }
 
    object &operator=(object const &x) {
      operator=(object(x));
      return *this;
    }
 
    object &operator=(object &&x) noexcept;
 
    ~object() { close(); }
 
    void close();
 
    operator hid_t() const { return id; }
 
    [[nodiscard]] int get_ref_count() const;
 
    [[nodiscard]] bool is_valid() const;
  };
 
  // simple but useful aliases. It does NOT check the h5 type of the object.
  // FIXME : derive and make a check ??
 
  using dataset = object;
 
  using datatype = object;
 
  using dataspace = object;
 
  using proplist = object;
 
  using attribute = object;
 
  namespace detail {
 
    // Map a C++ type to an HDF5 type (specializations are in object.cpp).
    template <typename T>
    hid_t hid_t_of();
 
  } // namespace detail
 
  template <typename T>
  [[nodiscard]] datatype hdf5_type() {
    return object::from_borrowed(detail::hid_t_of<T>());
  }
 
  [[nodiscard]] std::string get_name_of_h5_type(datatype dt);
 
  [[nodiscard]] datatype get_hdf5_type(dataset ds);
 
  [[nodiscard]] bool hdf5_type_equal(datatype dt1, datatype dt2);
 
} // namespace h5
 
#endif // LIBH5_OBJECT_HPP