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