H5Node_traits.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 H5NODE_TRAITS_HPP
#define H5NODE_TRAITS_HPP
 
#include <string>
 
#include "../H5PropertyList.hpp"
#include "H5_definitions.hpp"
 
namespace h5gt {
 
template <typename Derivate>
class NodeTraits {
public:
 
  DataSet
  createDataSet(const std::string& dataset_name,
                const DataSpace& space,
                const DataType& type,
                const LinkCreateProps& linkCreateProps = LinkCreateProps(),
                const DataSetCreateProps& dsetCreateProps = DataSetCreateProps(),
                const DataSetAccessProps& dsetAccessProps = DataSetAccessProps());
 
  template<typename Type>
  DataSet
  createDataSet(const std::string& dataset_name,
                const DataSpace& space,
                const LinkCreateProps& linkCreateProps = LinkCreateProps(),
                const DataSetCreateProps& dsetCreateProps = DataSetCreateProps(),
                const DataSetAccessProps& dsetAccessProps = DataSetAccessProps());
 
  template <typename T>
  DataSet
  createDataSet(const std::string& dataset_name,
                const T& data,
                const LinkCreateProps& linkCreateProps = LinkCreateProps(),
                const DataSetCreateProps& dsetCreateProps = DataSetCreateProps(),
                const DataSetAccessProps& dsetAccessProps = DataSetAccessProps());
 
 
  template <std::size_t N>
  DataSet
  createDataSet(const std::string& dataset_name,
                const FixedLenStringArray<N>& data,
                const LinkCreateProps& linkCreateProps = LinkCreateProps(),
                const DataSetCreateProps& dsetCreateProps = DataSetCreateProps(),
                const DataSetAccessProps& dsetAccessProps = DataSetAccessProps());
 
  DataType getDataType(
      const std::string& dtype_name,
      const DataTypeAccessProps& dtypeAccessProps = DataTypeAccessProps()) const ;
 
  DataSet getDataSet(
      const std::string& dataset_name,
      const DataSetAccessProps& accessProps = DataSetAccessProps()) const;
 
  Group createGroup(const std::string& group_name,
                    const LinkCreateProps& linkCreateProps = LinkCreateProps(),
                    const GroupCreateProps& groupCreateProps = GroupCreateProps(),
                    const GroupAccessProps& groupAccessProps = GroupAccessProps());
 
  Group getGroup(const std::string& group_name,
                 const GroupAccessProps& groupAccessProps = GroupAccessProps()) const;
 
  File getFile() const;
 
  size_t getNumberObjects() const;
 
  std::string getObjectName(size_t index, const LinkAccessProps& linkAccessProps = LinkAccessProps()) const;
 
  LinkInfo getLinkInfo(const std::string& objName) const;
 
  std::string unpackSoftLink(const std::string& objName);
 
  std::string unpackExternalLink(const std::string& objName, std::string& fileName_out);
 
  bool rename(const std::string& src_path,
              const std::string& dest_path,
              const LinkCreateProps& linkCreateProps = LinkCreateProps(),
              const LinkAccessProps& linkAccessProps = LinkAccessProps()) const;
 
  std::vector<std::string> listObjectNames() const;
 
  bool exist(const std::string& obj_name,
             const LinkAccessProps& linkAccessProps = LinkAccessProps(),
             bool raise_errors = false) const;
 
  bool resolved(const std::string& obj_name,
                const LinkAccessProps& linkAccessProps = LinkAccessProps(),
                bool raise_errors = false) const;
 
  bool existAndResolved(const std::string& obj_name,
                        const LinkAccessProps& linkAccessProps = LinkAccessProps(),
                        bool raise_errors = false) const;
 
  bool hasObject(const std::string& objName, const ObjectType& objType,
                 const LinkAccessProps& linkAccessProps = LinkAccessProps(),
                 bool raise_errors = false) const;
 
  void unlink(const std::string& obj_name, const LinkAccessProps& linkAccessProps = LinkAccessProps()) const;
 
  LinkType getLinkType(const std::string& obj_name,
                       const LinkAccessProps& linkAccessProps = LinkAccessProps()) const;
 
  inline ObjectType getObjectType(const std::string& obj_name, const LinkAccessProps& accessProps = LinkAccessProps()) const;
 
 
  Group copy(const Group& obj, const std::string& objNewName,
             const ObjectCopyProps& copyProps = ObjectCopyProps(),
             const LinkCreateProps& linkCreateProps = LinkCreateProps(),
             const GroupAccessProps& groupAccessProps = GroupAccessProps());
 
  DataSet copy(const DataSet& obj, const std::string& objNewName,
               const ObjectCopyProps& copyProps = ObjectCopyProps(),
               const LinkCreateProps& linkCreateProps = LinkCreateProps(),
               const DataSetAccessProps& dsetAccessProps = DataSetAccessProps());
 
  DataType copy(const DataType& obj, const std::string& objNewName,
                const ObjectCopyProps& copyProps = ObjectCopyProps(),
                const LinkCreateProps& linkCreateProps = LinkCreateProps(),
                const DataTypeAccessProps& dtypeAccessProps = DataTypeAccessProps());
 
  template<typename Node,
           typename std::enable_if<
             std::is_same<Node, File>::value |
             std::is_same<Node, Group>::value>::type* = nullptr>
  Group createLink(
      const Node& target,
      const std::string& linkName,
      const LinkType& linkType,
      const std::string& targetPath = "",
      const LinkCreateProps& linkCreateProps = LinkCreateProps(),
      const LinkAccessProps& linkAccessProps = LinkAccessProps(),
      const GroupAccessProps& groupAccessProps = GroupAccessProps());
 
  DataSet createLink(
      const DataSet& target,
      const std::string& linkName,
      const LinkType& linkType,
      const std::string& targetPath = "",
      const LinkCreateProps& linkCreateProps = LinkCreateProps(),
      const LinkAccessProps& linkAccessProps = LinkAccessProps(),
      const DataSetAccessProps& dsetAccessProps = DataSetAccessProps());
 
  DataType createLink(
      const DataType& target,
      const std::string& linkName,
      const LinkType& linkType,
      const std::string& targetPath = "",
      const LinkCreateProps& linkCreateProps = LinkCreateProps(),
      const LinkAccessProps& linkAccessProps = LinkAccessProps(),
      const DataTypeAccessProps& dtypeAccessProps = DataTypeAccessProps());
 
private:
  typedef Derivate derivate_type;
 
  // A wrapper over the low-level H5Lexist
  // It makes behavior consistent among versions and by default transforms
  // errors to exceptions
  bool _exist(const std::string& node_name,
              const LinkAccessProps& accessProps = LinkAccessProps(),
              bool raise_errors = false) const;
 
  bool _resolved(const std::string& node_name,
                 const LinkAccessProps& accessProps = LinkAccessProps(),
                 bool raise_errors = false) const;
 
  // Opens an arbitrary object to obtain info
  Object _open(const std::string& node_name,
               const LinkAccessProps& accessProps = LinkAccessProps()) const;
 
  template<typename T>
  void _copy(const T& obj, const std::string& newName,
             const ObjectCopyProps& copyProps = ObjectCopyProps(),
             const LinkCreateProps& linkCreateProps = LinkCreateProps());
 
  template<typename T>
  void _createLink(
      T& target,
      const std::string& linkName,
      const LinkType& linkType,
      std::string targetPath = "",
      const LinkCreateProps& linkCreateProps = LinkCreateProps(),
      const LinkAccessProps& linkAccessProps = LinkAccessProps());
};
 
 
}  // namespace h5gt
 
 
#endif  // H5NODE_TRAITS_HPP