H5Group.hpp

Go to the documentation of this file.

/*
 *  Copyright (c), 2017, Adrien Devresse <adrien.devresse@epfl.ch>
 *
 *  Distributed under the Boost Software License, Version 1.0.
 *    (See accompanying file LICENSE_1_0.txt or copy at
 *          http://www.boost.org/LICENSE_1_0.txt)
 *
 */
#pragma once
 
#include <H5Gpublic.h>
 
#include "H5Object.hpp"
#include "bits/H5Friends.hpp"
#include "bits/H5_definitions.hpp"
#include "bits/H5Annotate_traits.hpp"
#include "bits/H5Node_traits.hpp"
#include "bits/H5Path_traits.hpp"
 
namespace HighFive {
 
namespace detail {
Group make_group(hid_t);
}  // namespace detail
 
class Group: public Object,
             public NodeTraits<Group>,
             public AnnotateTraits<Group>,
             public PathTraits<Group> {
  public:
    const static ObjectType type = ObjectType::Group;
 
    H5_DEPRECATED("Default constructor creates unsafe uninitialized objects")
    Group() = default;
 
    std::pair<unsigned int, unsigned int> getEstimatedLinkInfo() const;
 
    GroupCreateProps getCreatePropertyList() const {
        return details::get_plist<GroupCreateProps>(*this, H5Gget_create_plist);
    }
 
    Group(Object&& o) noexcept
        : Object(std::move(o)){};
 
  protected:
    using Object::Object;
 
    friend Group detail::make_group(hid_t);
    friend class File;
    friend class Reference;
#if HIGHFIVE_HAS_FRIEND_DECLARATIONS
    template <typename Derivate>
    friend class ::HighFive::NodeTraits;
#endif
};
 
inline std::pair<unsigned int, unsigned int> Group::getEstimatedLinkInfo() const {
    auto gcpl = getCreatePropertyList();
    auto eli = EstimatedLinkInfo(gcpl);
    return std::make_pair(eli.getEntries(), eli.getNameLength());
}
 
namespace detail {
inline Group make_group(hid_t hid) {
    return Group(hid);
}
}  // namespace detail
 
}  // namespace HighFive