H5Object.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 <ctime>
 
#include <H5Ipublic.h>
#include <H5Opublic.h>
 
#include "bits/H5_definitions.hpp"
#include "bits/H5Friends.hpp"
 
namespace HighFive {
 
enum class ObjectType {
    File,
    Group,
    UserDataType,
    DataSpace,
    Dataset,
    Attribute,
    Other  // Internal/custom object type
};
 
namespace detail {
Object make_object(hid_t hid);
}  // namespace detail
 
 
class Object {
  public:
    // move constructor, reuse hid
    Object(Object&& other) noexcept;
 
    // decrease reference counter
    ~Object();
 
    bool isValid() const noexcept;
 
    hid_t getId() const noexcept;
 
    ObjectInfo getInfo() const;
 
    ObjectType getType() const;
 
    // Check if refer to same object
    bool operator==(const Object& other) const noexcept {
        return _hid == other._hid;
    }
 
  protected:
    // empty constructor
    Object();
 
    // copy constructor, increase reference counter
    Object(const Object& other);
 
    // Init with an low-level object id
    explicit Object(hid_t);
 
    // Copy-Assignment operator
    Object& operator=(const Object& other);
 
    hid_t _hid;
 
  private:
    friend Object detail::make_object(hid_t);
    friend class Reference;
    friend class CompoundType;
 
#if HIGHFIVE_HAS_FRIEND_DECLARATIONS
    template <typename Derivate>
    friend class NodeTraits;
    template <typename Derivate>
    friend class AnnotateTraits;
    template <typename Derivate>
    friend class PathTraits;
#endif
};
 
 
class ObjectInfo {
  public:
    H5_DEPRECATED("Deprecated since HighFive 2.2. Soon supporting VOL tokens")
    haddr_t getAddress() const noexcept;
 
    size_t getRefCount() const noexcept;
 
    time_t getCreationTime() const noexcept;
 
    time_t getModificationTime() const noexcept;
 
  protected:
#if (H5Oget_info_vers < 3)
    H5O_info_t raw_info;
#else
    // Use compat H5O_info1_t while getAddress() is supported (deprecated)
    H5O_info1_t raw_info;
#endif
 
    friend class Object;
};
 
}  // namespace HighFive
 
#include "bits/H5Object_misc.hpp"