Viewing file:  H5Library.h (2.81 KB) -rw-r--r--
Select action/file-type:
 (+) |  (+) |  (+) | Code (+) | Session (+) |  (+) | SDB (+) |  (+) |  (+) |  (+) |  (+) |  (+) |
// C++ informative line for the emacs editor: -*- C++ -*-
/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
* Copyright by The HDF Group. *
* Copyright by the Board of Trustees of the University of Illinois. *
* All rights reserved. *
* *
* This file is part of HDF5. The full HDF5 copyright notice, including *
* terms governing use, modification, and redistribution, is contained in *
* the COPYING file, which can be found at the root of the source code *
* distribution tree, or in https://support.hdfgroup.org/ftp/HDF5/releases. *
* If you do not have access to either file, you may request a copy from *
* help@hdfgroup.org. *
* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
#ifndef __H5Library_H
#define __H5Library_H
namespace H5 {
/*! \class H5Library
\brief Class H5Library operates the HDF5 library globably.
It is not necessary to construct an instance of H5Library to use the
methods.
*/
class H5_DLLCPP H5Library {
public:
// Initializes the HDF5 library.
static void open();
// Flushes all data to disk, closes files, and cleans up memory.
static void close();
// Instructs library not to install atexit cleanup routine
static void dontAtExit();
// Returns the HDF library release number.
static void getLibVersion(unsigned& majnum, unsigned& minnum, unsigned& relnum);
// Verifies that the arguments match the version numbers compiled
// into the library
static void checkVersion(unsigned majnum, unsigned minnum, unsigned relnum);
// Walks through all the garbage collection routines for the library,
// which are supposed to free any unused memory they have allocated.
static void garbageCollect();
// Sets limits on the different kinds of free lists.
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);
// Initializes C++ library and registers terminating functions at exit.
// Only for the library functions, not for user-defined functions.
static void initH5cpp(void);
// Sends request for terminating the HDF5 library.
static void termH5cpp(void);
#ifndef DOXYGEN_SHOULD_SKIP_THIS
private:
// Default constructor - no instance ever created from outsiders
H5Library();
// Destructor
~H5Library();
#endif // DOXYGEN_SHOULD_SKIP_THIS
}; // end of H5Library
} // namespace H5
#endif // __H5Library_H
|