link.hpp

Go to the documentation of this file.

//
// (c) Copyright 2017 DESY,ESS
//
// This file is part of h5cpp.
//
// This library is free software; you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as published
// by the Free Software Foundation; either version 2.1 of the License, or
// (at your option) any later version.
//
// This library is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty ofMERCHANTABILITY
// or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public
// License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this library; if not, write to the
// Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor
// Boston, MA  02110-1301 USA
// ===========================================================================
//
// Author: Eugen Wintersberger <eugen.wintersberger@desy.de>
// Created on: Sep 11, 2017
//
#pragma once

#include <h5cpp/file/file.hpp>
#include <h5cpp/core/path.hpp>
#include <h5cpp/core/windows.hpp>
#include <h5cpp/property/link_access.hpp>
#include <h5cpp/node/types.hpp>

namespace hdf5 {
namespace node {

class Group;
class Node;

class DLL_EXPORT LinkTarget
{
  public:
    LinkTarget();

    explicit LinkTarget(const hdf5::Path &object_path);

    explicit LinkTarget(const hdf5::Path &object_path,const boost::filesystem::path &file_path);

    boost::filesystem::path file_path() const;

    hdf5::Path object_path() const;

  private:
    boost::filesystem::path file_;
    hdf5::Path              object_path_;
};

class DLL_EXPORT Link
{
  public:
    //1 \param link_name the name of the link below its parent
    Link(const file::File &file,
         const Path &parent_path,
         const std::string &link_name);

    Link() = default;

    Link(const Link &) = default;

    Path path() const;

    LinkTarget target(const property::LinkAccessList &lapl = property::LinkAccessList()) const;


    LinkType type(const property::LinkAccessList &lapl = property::LinkAccessList()) const;

    Group parent() const;

    const file::File &file() const;

    Node operator*() const;


    bool exists() const;

    bool is_resolvable() const;


    DLL_EXPORT friend bool operator==(const Link &lhs, const Link &rhs);

  private:
    file::File parent_file_;   
    Path parent_path_;   
#ifdef _MSC_VER
#pragma warning(push)
#pragma warning(disable: 4251)
#endif
    std::string  name_;  
#ifdef _MSC_VER
#pragma warning(pop)
#endif

    H5L_info_t get_link_info(const property::LinkAccessList &lapl) const;
    std::string get_link_value(const property::LinkAccessList &lapl) const;
    LinkTarget get_soft_link_target(const property::LinkAccessList &lapl) const;
    LinkTarget get_external_link_target(const property::LinkAccessList &lapl) const;
};

DLL_EXPORT bool operator!=(const Link &lhs, const Link &rhs);

DLL_EXPORT std::ostream &operator<<(std::ostream &stream,const Link &link);

} // namespace node
} // namespace hdf5