HighFive 2.9.0
HighFive - Header-only C++ HDF5 interface
Loading...
Searching...
No Matches
HighFive::PropertyList< T > Class Template Reference

HDF5 property Lists. More...

#include <H5PropertyList.hpp>

Inheritance diagram for HighFive::PropertyList< T >:
Collaboration diagram for HighFive::PropertyList< T >:

Public Member Functions

constexpr PropertyType getType () const noexcept
 return the type of this PropertyList
 
template<PropertyInterface P>
void add (const P &property)
 
- Public Member Functions inherited from HighFive::PropertyListBase
 PropertyListBase () noexcept
 
- Public Member Functions inherited from HighFive::Object
 Object (Object &&other) noexcept
 
 ~Object ()
 
bool isValid () const noexcept
 isValid
 
hid_t getId () const noexcept
 getId
 
ObjectInfo getInfo () const
 Retrieve several infos about the current object (address, dates, etc)
 
ObjectType getType () const
 Gets the fundamental type of the object (dataset, group, etc)
 
bool operator== (const Object &other) const noexcept
 

Static Public Member Functions

static const PropertyList< T > & Default () noexcept
 Return the Default property type object.
 
static PropertyList< T > Empty ()
 
- Static Public Member Functions inherited from HighFive::PropertyListBase
static const PropertyListBaseDefault () noexcept
 

Protected Member Functions

void _initializeIfNeeded ()
 
- Protected Member Functions inherited from HighFive::Object
 Object ()
 
 Object (const Object &other)
 
 Object (hid_t)
 
Objectoperator= (const Object &other)
 

Additional Inherited Members

- Protected Attributes inherited from HighFive::Object
hid_t _hid
 

Detailed Description

template<PropertyType T>
class HighFive::PropertyList< T >

HDF5 property Lists.

Member Function Documentation

◆ _initializeIfNeeded()

template<PropertyType T>
void HighFive::PropertyList< T >::_initializeIfNeeded ( )
inlineprotected

◆ add()

template<PropertyType T>
template<PropertyInterface P>
void HighFive::PropertyList< T >::add ( const P & property)
inline

Add a property to this property list. A property is an object which is expected to have a method with the following signature void apply(hid_t hid) const

Template Parameters
PropertyInterface

◆ Default()

template<PropertyType T>
static const PropertyList< T > & HighFive::PropertyList< T >::Default ( )
inlinestaticnoexcept

Return the Default property type object.

◆ Empty()

template<PropertyType T>
static PropertyList< T > HighFive::PropertyList< T >::Empty ( )
inlinestatic

Return a property list created via a call to H5Pcreate.

An empty property is needed when one wants getId() to immediately point at a valid HID. This is important when interfacing directly with HDF5 to set properties that haven't been wrapped by HighFive.

◆ getType()

template<PropertyType T>
constexpr PropertyType HighFive::PropertyList< T >::getType ( ) const
inlineconstexprnoexcept

return the type of this PropertyList


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