h5cpp  0.3.3
A modern C++ wrapper for the HDF5 C library
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Public Member Functions | List of all members
hdf5::node::LinkTarget Class Reference

link target descriptor More...

#include <link.hpp>

Public Member Functions

 LinkTarget ()
 default constructor More...
 
 LinkTarget (const hdf5::Path &object_path)
 constructor More...
 
 LinkTarget (const hdf5::Path &object_path, const boost::filesystem::path &file_path)
 constructor More...
 
boost::filesystem::path file_path () const
 get file path More...
 
hdf5::Path object_path () const
 get object path More...
 

Detailed Description

This class describes the target a link references. It consists of two parts

The latter one is required in order to handle external links where the object is not stored in the same file.

Constructor & Destructor Documentation

◆ LinkTarget() [1/3]

hdf5::node::LinkTarget::LinkTarget ( )

◆ LinkTarget() [2/3]

hdf5::node::LinkTarget::LinkTarget ( const hdf5::Path object_path)
explicit

Could be used mainly for internal hard or soft links. Its only argument is the path to the object within the file.

Parameters
object_pathpath to object within the file

◆ LinkTarget() [3/3]

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

Could be used for external links.

Parameters
object_pathpath to the object within the file
file_pathpath to the file within which the object is stored

Member Function Documentation

◆ file_path()

boost::filesystem::path hdf5::node::LinkTarget::file_path ( ) const

Return the path to the file where the link target is located.

◆ object_path()

hdf5::Path hdf5::node::LinkTarget::object_path ( ) const

Return the object path to the link target within its file.


The documentation for this class was generated from the following file: