1 | /* |
---|
2 | This is part of the OTF library. Copyright by ZIH, TU Dresden 2005-2008. |
---|
3 | Authors: Andreas Knuepfer, Holger Brunst, Ronny Brendel, Thomas Kriebitzsch |
---|
4 | */ |
---|
5 | |
---|
6 | /** |
---|
7 | * \mainpage Open Trace Format API Documentation |
---|
8 | * |
---|
9 | * \section introduction Introduction |
---|
10 | * |
---|
11 | * This library supports efficient parallel and distributed access to trace |
---|
12 | * data and offers selective reading access regarding arbitrary time |
---|
13 | * intervals, process selection and record types. Optional auxiliary |
---|
14 | * information can assist this selective access. |
---|
15 | * |
---|
16 | * The Open Trace Format makes use of a portable ASCII encoding. |
---|
17 | * It distributes single traces to multiple so called streams |
---|
18 | * with one or more files each. Merging of records from multiple files is done |
---|
19 | * transparently by the OTF library. The number of possible streams is not |
---|
20 | * limited by the number of available file handles. |
---|
21 | * |
---|
22 | * |
---|
23 | * For more information read the specification (docu/api/specification.pdf) |
---|
24 | * |
---|
25 | * OTF is available under the BSD open source license that allows free usage |
---|
26 | * for academic and commercial applications. |
---|
27 | * |
---|
28 | * |
---|
29 | * \section quicklinks Quick Links |
---|
30 | * |
---|
31 | * \subsection interfaces Interfaces |
---|
32 | * - \ref reader "Global Reader" - \ref rstream "Stream Reader" |
---|
33 | * - \ref writer "Global Writer" - \ref wstream "Stream Writer " |
---|
34 | * - \ref handler "Handlers" - \ref ha "Handler Array" |
---|
35 | * |
---|
36 | * - \ref fm "File Manager" |
---|
37 | * - \ref mc "Master Control" |
---|
38 | * |
---|
39 | * - \ref misc "Miscellaneous" |
---|
40 | * |
---|
41 | * \subsection examples Examples |
---|
42 | * - \ref reader_example1 "Reader" |
---|
43 | * - \ref reader_example2 "Reader 2" |
---|
44 | * - \ref rstream_example "Stream Reader" |
---|
45 | * - \ref writer_example "Writer" |
---|
46 | * - \ref wstream_example "Stream Writer" |
---|
47 | * - \ref mc_example "Master Control" |
---|
48 | * |
---|
49 | * \subsection Contact |
---|
50 | * - report bugs to andreas.knuepfer@tu-dresden.de |
---|
51 | * - <a href="http://www.tu-dresden.de/zih/otf">OTF-Home</a> |
---|
52 | * |
---|
53 | */ |
---|
54 | |
---|
55 | /** |
---|
56 | * @file otf.h |
---|
57 | * |
---|
58 | * @brief Main include file for applications using OTF. |
---|
59 | */ |
---|
60 | |
---|
61 | |
---|
62 | /** |
---|
63 | * \defgroup misc Miscellaneous |
---|
64 | */ |
---|
65 | |
---|
66 | /** |
---|
67 | * \defgroup internal Internal Interfaces |
---|
68 | * |
---|
69 | * All files in this module contain Interfaces that are not meant to be accessed directly. |
---|
70 | */ |
---|
71 | |
---|
72 | #ifndef OTF_H |
---|
73 | #define OTF_H |
---|
74 | |
---|
75 | |
---|
76 | #include "OTF_Definitions.h" |
---|
77 | #include "OTF_FileManager.h" |
---|
78 | #include "OTF_Filenames.h" |
---|
79 | #include "OTF_HandlerArray.h" |
---|
80 | #include "OTF_MasterControl.h" |
---|
81 | #include "OTF_RStream.h" |
---|
82 | #include "OTF_Reader.h" |
---|
83 | #include "OTF_WStream.h" |
---|
84 | #include "OTF_Writer.h" |
---|
85 | |
---|
86 | |
---|
87 | #endif /* OTF_H */ |
---|
88 | |
---|