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

#include <creation_order.hpp>

Public Member Functions

 CreationOrder ()
 default constructor More...
 
 CreationOrder (const CreationOrder &c)=default
 copy constructor More...
 
 CreationOrder (unsigned value)
 constructor More...
 
CreationOrderenable_tracked ()
 enable tracked creation order More...
 
CreationOrderdisable_tracked ()
 disable tracked creation order More...
 
CreationOrderenable_indexed ()
 enable indexed creation order More...
 
CreationOrderdisable_indexed ()
 disable indexed creation order More...
 
bool tracked () const
 query if tracked creation order is enabled More...
 
bool indexed () const
 query if indexed creation order is enabled More...
 
 operator unsigned () const
 conversion operator More...
 

Constructor & Destructor Documentation

◆ CreationOrder() [1/3]

hdf5::property::CreationOrder::CreationOrder ( )

◆ CreationOrder() [2/3]

hdf5::property::CreationOrder::CreationOrder ( const CreationOrder c)
default
Parameters
creference from which to copy

◆ CreationOrder() [3/3]

hdf5::property::CreationOrder::CreationOrder ( unsigned  value)
explicit
Parameters
valueflags from which to construct the instance

Member Function Documentation

◆ disable_indexed()

CreationOrder& hdf5::property::CreationOrder::disable_indexed ( )

This does not automatically disable also tracked creation order.

Returns
reference to the modified instance
See also
enable_tracked

◆ disable_tracked()

CreationOrder& hdf5::property::CreationOrder::disable_tracked ( )
Returns
reference to the modified instance
See also
enable_tracked

◆ enable_indexed()

CreationOrder& hdf5::property::CreationOrder::enable_indexed ( )

This implies also tracked creation order which will be enabled by this method automatically if it is not.

Returns
reference to the modified instance
See also
disable_indexed

◆ enable_tracked()

CreationOrder& hdf5::property::CreationOrder::enable_tracked ( )
Returns
reference to the modified instance
See also
disable_tracked

◆ indexed()

bool hdf5::property::CreationOrder::indexed ( ) const
Returns
true if creation order indexed is enabled, false otherwise

◆ operator unsigned()

hdf5::property::CreationOrder::operator unsigned ( ) const
inline

Allows the conversion of an instance of this class to an unsigned integer value which can be used with the HDF5 C-API low level functions.

◆ tracked()

bool hdf5::property::CreationOrder::tracked ( ) const
Returns
true if creation order is tracked, false otherwise

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