otf.h 2.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
/*
 This is part of the OTF library. Copyright by ZIH, TU Dresden 2005-2010.
 Authors: Andreas Knuepfer, Holger Brunst, Ronny Brendel, Thomas Kriebitzsch
*/

/**
 *  \mainpage Open Trace Format API Documentation
 *
 *  \section introduction Introduction
 *
 *  This library supports efficient parallel and distributed access to trace
 *  data and offers selective reading access regarding arbitrary time
 *  intervals, process selection and record types. Optional auxiliary
 *  information can assist this selective access.
 *
 *  The Open Trace Format makes use of a portable ASCII encoding.
 *  It distributes single traces to multiple so called streams
 *  with one or more files each. Merging of records from multiple files is done
 *  transparently by the OTF library. The number of possible streams is not
 *  limited by the number of available file handles.
 *
 *
 *   For more information read the specification (docu/api/specification.pdf)
 *
 *   OTF is available under the BSD open source license that allows free usage
 *   for academic and commercial applications.
 *
 *
 *  \section quicklinks Quick Links
 *
 *   \subsection interfaces Interfaces
 *     - \ref reader "Global Reader" - \ref rstream "Stream Reader"
 *     - \ref writer "Global Writer" - \ref wstream "Stream Writer "
 *     - \ref handler "Handlers" - \ref ha "Handler Array"
 *
 *     - \ref fm "File Manager"
 *     - \ref mc "Master Control"
 *
 *     - \ref keyvalue "KeyValueList"
 *
 *     - \ref misc "Miscellaneous"
 *
 *   \subsection examples Examples
 *     - \ref reader_example1 "Reader"
 *     - \ref reader_example2 "Reader 2"
 *     - \ref rstream_example "Stream Reader"
 *     - \ref writer_example "Writer"
 *     - \ref wstream_example "Stream Writer"
 *     - \ref mc_example "Master Control"
 *     - \ref keyvalue_read_example "KeyValueList - Read"
 *     - \ref keyvalue_write_example "KeyValueList - Write"
 *
 *   \subsection Contact
 *     - report bugs to andreas.knuepfer@tu-dresden.de
 *     - <a href="http://www.tu-dresden.de/zih/otf">OTF-Home</a>
 *
 */

/** 
 *  @file otf.h
 * 
 *  @brief Main include file for applications using OTF.
 */


/**
 * \defgroup misc Miscellaneous
 */

/**
 * \defgroup internal Internal Interfaces
 *
 * All files in this module contain Interfaces that are not meant to be accessed directly.
 */

#ifndef OTF_H
#define OTF_H


#include "OTF_Definitions.h"
#include "OTF_KeyValue.h"
#include "OTF_FileManager.h"
#include "OTF_Filenames.h"
#include "OTF_HandlerArray.h"
#include "OTF_MasterControl.h"
#include "OTF_RStream.h"
#include "OTF_Reader.h"
#include "OTF_WStream.h"
#include "OTF_Writer.h"


#endif /* OTF_H */