A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
stats.h
Go to the documentation of this file.
1/*
2 * Copyright (c) 2013 Universita' di Firenze
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
18 */
19
20#ifndef STATS_H
21#define STATS_H
22
23// Header file used only to define the stats group in Doxygen
24
25/**
26 * \defgroup stats Statistics
27 *
28 * The statistics module includes some useful features to ease data collection from experiments.
29 * In particular the following features are included:
30 * <ul>
31 * <li> The core framework and two basic data collectors: A counter, and a min/max/avg/total
32 * observer.</li> <li> Extensions of those to easily work with times and packets.</li> <li>
33 * Plaintext output formatted for OMNet++.</li> <li> Database output using SQLite, a standalone,
34 * lightweight, high performance SQL engine.</li> <li> Mandatory and open ended metadata for
35 * describing and working with runs.</li>
36 * </ul>
37 *
38 * See the manual for a complete documentation.
39 */
40
41/**
42 * \ingroup stats
43 * \defgroup aggregator Data Aggregators
44 *
45 * Data aggregators are classes used to collect data and produce output
46 * specialized for various purpose, e.g., Gnuplot, file output, etc.
47 */
48
49/**
50 * \ingroup stats
51 * \defgroup probes Probes
52 *
53 * Probes are used to probe an underlying ns3 TraceSource exporting
54 * its value. This probe usually exports a trace source "Output".
55 * The Output trace source emits a value when either the trace source
56 * emits a new value, or when SetValue () is called.
57 *
58 * Probes are a special kind of Trace Source.
59 */
60
61/**
62 * \ingroup stats
63 * \defgroup gnuplot Gnuplot
64 *
65 * Classes in Gnuplot group are used to collect and prepare and output data
66 * for subsequent processing by Gnuplot.
67 */
68
69/**
70 * \ingroup stats
71 * \defgroup dataoutput Data Output
72 *
73 * Classes in Data Output group are used to collect and prepare and output data
74 * for subsequent output in a specific format, e.g., Omnet++, SQLite, etc.
75 */
76
77/**
78 * \ingroup stats
79 * \ingroup tests
80 * \defgroup stats-tests Statistics module tests
81 */
82
83#endif /* STATS_H */