h5cpp  0.5.1
A modern C++ wrapper for the HDF5 C library
hdf5::property::List Class Reference

base class for property lists

#include <property_list.hpp>

Inheritance diagram for hdf5::property::List:

Public Member Functions

 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...
 

Constructor & Destructor Documentation

◆ List() [1/4]

hdf5::property::List::List ( const Class plist_class)
explicit
Parameters
plist_classreference to the property list class

◆ List() [2/4]

hdf5::property::List::List ( const List plist)
Parameters
plistreference to the original property list

◆ List() [3/4]

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

Construct a property list from a handler object. This constructor is particularly useful in situations where we retrieve the handler of a property list from a C-API function.

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

◆ ~List()

virtual hdf5::property::List::~List ( )
virtual

◆ List() [4/4]

hdf5::property::List::List ( List &&  type)
default

Member Function Documentation

◆ get_class()

Class hdf5::property::List::get_class ( ) const

Return an instance of the property list class the list belongs to.

Returns
class instance

◆ operator hid_t()

hdf5::property::List::operator hid_t ( ) const
inlineexplicit

Use this operator to obtain the actual HDF5 handler to the list instance.

◆ operator=() [1/2]

List& hdf5::property::List::operator= ( const List type)

◆ operator=() [2/2]

List& hdf5::property::List::operator= ( List &&  type)
default

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