h5cpp  0.5.0
A modern C++ wrapper for the HDF5 C library
hdf5::property::LinkAccessList Class Reference

link access property list

#include <link_access.hpp>

Inheritance diagram for hdf5::property::LinkAccessList:
Collaboration diagram for hdf5::property::LinkAccessList:

Public Member Functions

 LinkAccessList ()
 default constructor More...
 
 LinkAccessList (ObjectHandle &&handle)
 
size_t maximum_link_traversals () const
 get maximum number of link traversals More...
 
void maximum_link_traversals (size_t size) const
 set maximum number of link traversals More...
 
fs::path external_link_prefix () const
 get external link prefix More...
 
void external_link_prefix (const fs::path &path)
 set external link prefix More...
 
- Public Member Functions inherited from hdf5::property::List
 List (const Class &plist_class)
 constructor More...
 
 List (const List &plist)
 copy constructor More...
 
 List (ObjectHandle &&handle)
 constructor More...
 
Listoperator= (const List &type)
 copy assignment More...
 
virtual ~List ()
 destructor More...
 
Listoperator= (List &&type)=default
 
 List (List &&type)=default
 
Class get_class () const
 return property list class More...
 
 operator hid_t () const
 conversion operator More...
 

Protected Member Functions

 LinkAccessList (const Class &plist_class)
 constructor More...
 

Constructor & Destructor Documentation

◆ LinkAccessList() [1/3]

hdf5::property::LinkAccessList::LinkAccessList ( )

◆ LinkAccessList() [2/3]

hdf5::property::LinkAccessList::LinkAccessList ( ObjectHandle &&  handle)
explicit

◆ LinkAccessList() [3/3]

hdf5::property::LinkAccessList::LinkAccessList ( const Class plist_class)
protected

This protected constructor is used for the construction of child-classes.

Member Function Documentation

◆ external_link_prefix() [1/2]

fs::path hdf5::property::LinkAccessList::external_link_prefix ( ) const

Returns the prefix prepended to every path in an external link.

Exceptions
std::runtime_errorin case of a failure
Returns
prefix as an instance of fs
See also
external_link_prefix

◆ external_link_prefix() [2/2]

void hdf5::property::LinkAccessList::external_link_prefix ( const fs::path &  path)

Sets the external link prefix for a path. As the this information is stored internally and must be kept valid throughout the lifetime of the property list this method cannot be const.

Exceptions
std::runtime_errorin case of a failure
Parameters
pathreference to a fs path containing the prefix
See also
external_link_prefix

◆ maximum_link_traversals() [1/2]

size_t hdf5::property::LinkAccessList::maximum_link_traversals ( ) const

◆ maximum_link_traversals() [2/2]

void hdf5::property::LinkAccessList::maximum_link_traversals ( size_t  size) const

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