h5cpp  0.6
A modern C++ wrapper for the HDF5 C library
hdf5::property::DatasetAccessList Class Reference

dataset access property list

#include <dataset_access.hpp>

Inheritance diagram for hdf5::property::DatasetAccessList:
Collaboration diagram for hdf5::property::DatasetAccessList:

Public Member Functions

 DatasetAccessList ()
 default constructor More...
 
 DatasetAccessList (ObjectHandle &&handle)
 constructor More...
 
 ~DatasetAccessList () override
 destructor More...
 
void chunk_cache_parameters (const ChunkCacheParameters &params) const
 set the chunk cache parameters More...
 
ChunkCacheParameters chunk_cache_parameters () const
 get chunk cache parameters More...
 
void virtual_view (VirtualDataView view) const
 missing data handling for virtual datasets (since hdf5 1.10.0) More...
 
VirtualDataView virtual_view () const
 get missing data strategy for virtual datasets (since hdf5 1.10.0) More...
 
- Public Member Functions inherited from hdf5::property::LinkAccessList
 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...
 

Additional Inherited Members

- Protected Member Functions inherited from hdf5::property::LinkAccessList
 LinkAccessList (const Class &plist_class)
 constructor More...
 

Constructor & Destructor Documentation

◆ DatasetAccessList() [1/2]

hdf5::property::DatasetAccessList::DatasetAccessList ( )

◆ DatasetAccessList() [2/2]

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

Construct a dataset access property list from a handler instance. This constructor will throw an exception if the handle does not reference a dataset access property list.

Exceptions
std::runtime_errorin case of a failure
Parameters
handler-value reference to a handle instance

◆ ~DatasetAccessList()

hdf5::property::DatasetAccessList::~DatasetAccessList ( )
override

Member Function Documentation

◆ chunk_cache_parameters() [1/2]

ChunkCacheParameters hdf5::property::DatasetAccessList::chunk_cache_parameters ( ) const
Exceptions
std::runtime_errorin case of a failure

◆ chunk_cache_parameters() [2/2]

void hdf5::property::DatasetAccessList::chunk_cache_parameters ( const ChunkCacheParameters params) const
Exceptions
std::runtime_errorin case of a failure

◆ virtual_view() [1/2]

VirtualDataView hdf5::property::DatasetAccessList::virtual_view ( ) const

◆ virtual_view() [2/2]

void hdf5::property::DatasetAccessList::virtual_view ( VirtualDataView  view) const
Exceptions
std::runtime_errorin case of a failure
Parameters
viewset missing data strategy

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