H5Object.hpp

/*
 *  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)
 *
 */
#ifndef H5OBJECT_HPP
#define H5OBJECT_HPP
 
#include <ctime>
 
#include <H5Ipublic.h>
#include <H5Opublic.h>
 
#include "H5Exception.hpp"
#include "bits/H5_definitions.hpp"
 
//----------------------------------------------------------------//
// H5Object.hpp H5Object_misc.hpp cant contain variables          //
// of type H5PropertyLists as H5Object.hpp is included            //
// by H5PropertyLists.hpp                                         //
// You will get recursion hell if break this rule                 //
//----------------------------------------------------------------//
 
namespace h5gt {
 
class LinkAccessProps;
 
enum class ObjectType {
  File,
  Group,
  UserDataType,
  DataSpace,
  Dataset,
  Attribute,
  Other  // Internal/custom object type
};
 
enum class LinkType {
  Hard,
  Soft,
  External,
  Other  // Reserved or User-defined
};
 
 
class Object {
public:
  // decrease reference counter
  ~Object();
 
  void flush(bool globalScope = true);
 
  bool isValid() const noexcept;
 
#if (H5_VERS_MAJOR >= 1 && H5_VERS_MINOR >= 10)
  bool refresh() const noexcept;
#endif
 
  hid_t getId(const bool& increaseRefCount = false) const noexcept;
 
  std::string getFileName() const;
 
  std::string getPath() const;
 
  int getIdRefCount() const noexcept;
 
  ObjectInfo getObjectInfo() const;
 
  ObjectType getObjectType() const;
 
protected:
  // empty constructor
  Object();
 
  // copy constructor, increase reference counter
  Object(const Object& other);
 
  // move constructor, reuse hid
  Object(Object&& other) noexcept;
 
  // Init with an low-level object id
  explicit Object(const hid_t&);
  explicit Object(const hid_t&, const ObjectType&, const bool&);
 
  LinkInfo _getLinkInfo(const std::string& objPath) const;
 
  std::string _unpackSoftLink(
      const std::string& objName) const;
  std::string _unpackExternalLink(
      const std::string& objName,
      std::string& fileName_out) const;
  void _unlink(const std::string& obj_name) const;
 
  Object& operator=(const Object& other);
  bool operator==(const Object& other) const;
 
  hid_t _hid;
 
private:
 
  template <typename Derivate> friend class NodeTraits;
  template <typename Derivate> friend class AnnotateTraits;
  friend class Reference;
  friend class DataSpace;
  friend class File;
  friend class Group;
  friend class DataSet;
  friend class Attribute;
  friend class DataType;
  friend class Selection;
};
 
 
class ObjectInfo {
public:
#if (H5Oget_info_vers < 3)
  haddr_t getAddress() const noexcept;
#else
  H5O_token_t getHardLinkToken() const noexcept;
#endif
 
  unsigned long  getFileNumber() const noexcept;
 
  size_t getHardLinkRefCount() const noexcept;
 
  time_t getAccessTime() const noexcept;
  time_t getModificationTime() const noexcept;
  time_t getChangeTime() const noexcept;
  time_t getCreationTime() const noexcept;
  hsize_t getNumAttr() const noexcept;
 
protected:
 
#if (H5Oget_info_vers < 3)
  H5O_info_t raw_info;
#else
  H5O_info2_t raw_info;
#endif
 
  friend class Object;
};
 
class LinkInfo  {
public:
  LinkType getLinkType() const noexcept;
  hbool_t creationOrderValid() const noexcept;
  int64_t getCreationOrder() const noexcept;
  H5T_cset_t getLinkNameCharacterSet() const noexcept;
#if (H5Lget_info_vers < 2)
  haddr_t getAddress() const noexcept;
#else
  H5O_token_t getHardLinkToken() const noexcept;
#endif
  size_t getSoftLinkSize() const noexcept;
 
protected:
#if (H5Lget_info_vers < 2)
  H5L_info_t link_info;
#else
  H5L_info2_t link_info;
#endif
 
  friend class Object;
};
 
}  // namespace h5gt
 
#include "bits/H5Object_misc.hpp"
 
#endif // H5OBJECT_HPP