H5Node_traits.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)
 *
 */
#ifndef H5NODE_TRAITS_HPP
#define H5NODE_TRAITS_HPP
 
#include <string>
 
#include "../H5PropertyList.hpp"
#include "H5_definitions.hpp"
 
namespace HighFive {
 
template <typename Derivate>
class NodeTraits {
  public:
    DataSet
    createDataSet(const std::string& dataset_name,
                  const DataSpace& space,
                  const DataType& type,
                  const DataSetCreateProps& createProps = DataSetCreateProps(),
                  const DataSetAccessProps& accessProps = DataSetAccessProps());
 
    template <typename Type>
    DataSet
    createDataSet(const std::string& dataset_name,
                  const DataSpace& space,
                  const DataSetCreateProps& createProps = DataSetCreateProps(),
                  const DataSetAccessProps& accessProps = DataSetAccessProps());
 
    template <typename T>
    DataSet
    createDataSet(const std::string& dataset_name,
                  const T& data,
                  const DataSetCreateProps& createProps = DataSetCreateProps(),
                  const DataSetAccessProps& accessProps = DataSetAccessProps());
 
 
    template <std::size_t N>
    DataSet
    createDataSet(const std::string& dataset_name,
                  const FixedLenStringArray<N>& data,
                  const DataSetCreateProps& createProps = DataSetCreateProps(),
                  const DataSetAccessProps& accessProps = DataSetAccessProps());
 
    DataSet getDataSet(
        const std::string& dataset_name,
        const DataSetAccessProps& accessProps = DataSetAccessProps()) const;
 
    Group createGroup(const std::string& group_name, bool parents = true);
 
    Group getGroup(const std::string& group_name) const;
 
    size_t getNumberObjects() const;
 
    std::string getObjectName(size_t index) const;
 
    std::string getPath() const;
 
    bool rename(const std::string& src_path,
                const std::string& dest_path,
                bool parents = true) const;
 
    std::vector<std::string> listObjectNames() const;
 
    bool exist(const std::string& node_name) const;
 
    void unlink(const std::string& node_name) const;
 
    LinkType getLinkType(const std::string& node_name) const;
 
    inline ObjectType getObjectType(const std::string& node_name) const;
 
  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, bool raise_errors = true) const;
 
    // Opens an arbitrary object to obtain info
    Object _open(const std::string& node_name,
                 const DataSetAccessProps& accessProps = DataSetAccessProps()) const;
};
 
 
enum class LinkType {
    Hard,
    Soft,
    External,
    Other  // Reserved or User-defined
};
 
 
}  // namespace HighFive
 
 
#endif  // H5NODE_TRAITS_HPP