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

#include <object_creation.hpp>

Inheritance diagram for hdf5::property::ObjectCreationList:
Collaboration diagram for hdf5::property::ObjectCreationList:

Public Member Functions

 ObjectCreationList ()
 constructor More...
 
 ObjectCreationList (const ObjectCreationList &)=default
 
virtual ~ObjectCreationList () override
 destructor More...
 
 ObjectCreationList (ObjectHandle &&handle)
 
void enable_time_tracking () const
 enable object time tracking More...
 
void disable_time_tracking () const
 disable object time tracking More...
 
bool time_tracking () const
 return time tacking status More...
 
void attribute_creation_order (const CreationOrder &order) const
 set the attribute creation order More...
 
CreationOrder attribute_creation_order () const
 retrieve current attribute creation order More...
 
void attribute_storage_thresholds (unsigned max_compact, unsigned min_dense) const
 set storage layout thresholds More...
 
unsigned attribute_storage_maximum_compact () const
 get upper threshold for compact storage More...
 
unsigned attribute_storage_minimum_dense () const
 get lower threshold for dense threshold 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

 ObjectCreationList (const Class &plist_class)
 

Constructor & Destructor Documentation

◆ ObjectCreationList() [1/4]

hdf5::property::ObjectCreationList::ObjectCreationList ( )

◆ ObjectCreationList() [2/4]

hdf5::property::ObjectCreationList::ObjectCreationList ( const ObjectCreationList )
default

◆ ~ObjectCreationList()

virtual hdf5::property::ObjectCreationList::~ObjectCreationList ( )
overridevirtual

◆ ObjectCreationList() [3/4]

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

◆ ObjectCreationList() [4/4]

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

Member Function Documentation

◆ attribute_creation_order() [1/2]

CreationOrder hdf5::property::ObjectCreationList::attribute_creation_order ( ) const
Returns
current attribute creation order
See also
attribute_creation_order
CreationOrder

◆ attribute_creation_order() [2/2]

void hdf5::property::ObjectCreationList::attribute_creation_order ( const CreationOrder order) const

Set the attribute creation order flags which will be used for all objects.

Parameters
orderrequested attribute creation order
See also
CreationOrder
attribute_creation_order()

◆ attribute_storage_maximum_compact()

unsigned hdf5::property::ObjectCreationList::attribute_storage_maximum_compact ( ) const
Returns
return the upper threshhold for which compat storage is used

◆ attribute_storage_minimum_dense()

unsigned hdf5::property::ObjectCreationList::attribute_storage_minimum_dense ( ) const

◆ attribute_storage_thresholds()

void hdf5::property::ObjectCreationList::attribute_storage_thresholds ( unsigned  max_compact,
unsigned  min_dense 
) const
Parameters
max_compactmaximum number above which dense storage will be used
min_denseminimum number below which compact storage will be used
See also
attribute_storage_maximum_compact
attribute_storage_minimum_dense

◆ disable_time_tracking()

void hdf5::property::ObjectCreationList::disable_time_tracking ( ) const

◆ enable_time_tracking()

void hdf5::property::ObjectCreationList::enable_time_tracking ( ) const

Activates the time tracking feature on objects in the file.

See also
disable_time_tracking
time_tracking

◆ time_tracking()

bool hdf5::property::ObjectCreationList::time_tracking ( ) const

Queries the current status of the time tracking feature. This method returns true if time tracking is activate and false otherwise.

Exceptions
std::runtime_errrin case of an error
Returns
true if time tracking is active, false otherwise
See also
enable_time_tracking
disable_time_tracking

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