My Project 1.10.10
Loading...
Searching...
No Matches
H5Library.h
1// C++ informative line for the emacs editor: -*- C++ -*-
2/* * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
3 * Copyright by The HDF Group. *
4 * All rights reserved. *
5 * *
6 * This file is part of HDF5. The full HDF5 copyright notice, including *
7 * terms governing use, modification, and redistribution, is contained in *
8 * the COPYING file, which can be found at the root of the source code *
9 * distribution tree, or in https://www.hdfgroup.org/licenses. *
10 * If you do not have access to either file, you may request a copy from *
11 * help@hdfgroup.org. *
12 * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * */
13
14#ifndef H5Library_H
15#define H5Library_H
16
17namespace H5 {
18
25class H5_DLLCPP H5Library {
26 public:
27 // Initializes the HDF5 library.
28 static void open();
29
30 // Flushes all data to disk, closes files, and cleans up memory.
31 static void close();
32
33 // Instructs library not to install atexit cleanup routine
34 static void dontAtExit();
35
36 // Returns the HDF library release number.
37 static void getLibVersion(unsigned &majnum, unsigned &minnum, unsigned &relnum);
38
39 // Verifies that the arguments match the version numbers compiled
40 // into the library
41 static void checkVersion(unsigned majnum, unsigned minnum, unsigned relnum);
42
43 // Walks through all the garbage collection routines for the library,
44 // which are supposed to free any unused memory they have allocated.
45 static void garbageCollect();
46
47 // Sets limits on the different kinds of free lists.
48 static void setFreeListLimits(int reg_global_lim, int reg_list_lim, int arr_global_lim, int arr_list_lim,
49 int blk_global_lim, int blk_list_lim);
50
51 // Initializes C++ library and registers terminating functions at exit.
52 // Only for the library functions, not for user-defined functions.
53 static void initH5cpp(void);
54
55 // Sends request for terminating the HDF5 library.
56 static void termH5cpp(void);
57
58#ifndef DOXYGEN_SHOULD_SKIP_THIS
59
60 private:
61 // Default constructor - no instance ever created from outsiders
62 H5Library();
63
64 // Destructor
65 ~H5Library();
66#endif // DOXYGEN_SHOULD_SKIP_THIS
67
68}; // end of H5Library
69} // namespace H5
70
71#endif // H5Library_H
Class H5Library operates the HDF5 library globably.
Definition H5Library.h:25
Definition H5AbstractDs.cpp:33


The HDF Group Help Desk:
  Copyright by The HDF Group