HDF5 C++ API  1.10.1
 All Classes Namespaces Functions Variables Typedefs Friends Pages
Static Public Member Functions | List of all members
H5::H5Library Class Reference

Class H5Library operates the HDF5 library globably. More...

#include <H5Library.h>

Static Public Member Functions

static void open ()
 Initializes the HDF5 library. More...
static void close ()
 Flushes all data to disk, closes files, and cleans up memory. More...
static void dontAtExit ()
 Instructs library not to install the C atexit cleanup routine. More...
static void getLibVersion (unsigned &majnum, unsigned &minnum, unsigned &relnum)
 Returns the HDF library release number. More...
static void checkVersion (unsigned majnum, unsigned minnum, unsigned relnum)
 Verifies that the arguments match the version numbers compiled into the library. More...
static void garbageCollect ()
 Walks through all the garbage collection routines for the library, which are supposed to free any unused memory they have allocated. More...
static void setFreeListLimits (int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim, int blk_global_lim, int blk_list_lim)
 Sets limits on the different kinds of free lists. More...
static void initH5cpp (void)
 Initializes C++ library and registers terminating functions at exit. Only for the library functions, not for user-defined functions. More...
static void termH5cpp (void)
 Sends request for the C layer to terminate. More...

Detailed Description

It is not neccessary to construct an instance of H5Library to use the methods.

Member Function Documentation

void H5::H5Library::checkVersion ( unsigned  majnum,
unsigned  minnum,
unsigned  relnum 
majnum- IN: Major version of the library
minnum- IN: Minor version of the library
relnum- IN: Release number of the library
For information about library version, please refer to the C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-VersCheck
void H5::H5Library::close ( )
void H5::H5Library::dontAtExit ( )
void H5::H5Library::garbageCollect ( )
It is not required that H5Library::garbageCollect be called at any particular time; it is only necessary in certain situations, such as when the application has performed actions that cause the library to allocate many objects. The application should call H5Library::garbageCollect if it eventually releases those objects and wants to reduce the memory used by the library from the peak usage required.
The library automatically garbage collects all the free lists when the application ends.
void H5::H5Library::getLibVersion ( unsigned &  majnum,
unsigned &  minnum,
unsigned &  relnum 
majnum- OUT: Major version of the library
minnum- OUT: Minor version of the library
relnum- OUT: Release number of the library
void H5::H5Library::initH5cpp ( void  )
void H5::H5Library::open ( )
void H5::H5Library::setFreeListLimits ( int  reg_global_lim,
int  reg_list_lim,
int  arr_global_lim,
int  arr_list_lim,
int  blk_global_lim,
int  blk_list_lim 
reg_global_lim- IN: Limit on all "regular" free list memory used
reg_list_lim- IN: Limit on memory used in each "regular" free list
arr_global_lim- IN: Limit on all "array" free list memory used
arr_list_lim- IN: Limit on memory used in each "array" free list
blk_global_lim- IN: Limit on all "block" free list memory used
blk_list_lim- IN: Limit on memory used in each "block" free list
Setting a value of -1 for a limit means no limit of that type. For more information on free list limits, please refer to C layer Reference Manual at: http://www.hdfgroup.org/HDF5/doc/RM/RM_H5.html#Library-SetFreeListLimits
void H5::H5Library::termH5cpp ( void  )
If the C library fails to terminate, exit with a failure.

Referenced by initH5cpp().

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

The HDF Group Help Desk:
  Copyright by The HDF Group
and the Board of Trustees of the University of Illinois