highfive/bits/H5Path_traits.hpp

0001 /*
0002  *  Copyright (c), 2020, EPFL - Blue Brain Project
0003  *
0004  *  Distributed under the Boost Software License, Version 1.0.
0005  *    (See accompanying file LICENSE_1_0.txt or copy at
0006  *          http://www.boost.org/LICENSE_1_0.txt)
0007  *
0008  */
0009 #pragma once
0010
0011 #include "H5_definitions.hpp"
0012
0013 namespace HighFive {
0014
0015 template <typename Derivate>
0016 class PathTraits {
0017   public:
0018     PathTraits();
0019
0020     ///
0021     /// \brief return the path to the current object
0022     /// \return the path to the object
0023     std::string getPath() const;
0024
0025     ///
0026     /// \brief Return a reference to the File object this object belongs
0027     /// \return the File object ref
0028     File& getFile() const noexcept;
0029
0030
0031   protected:
0032     std::shared_ptr<File> _file_obj;  // keep a ref to file so we keep its ref count > 0
0033 };
0034
0035 }  // namespace HighFive