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 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
7 */
8
9#ifndef STATS_H
10#define STATS_H
11
12// Header file used only to define the stats group in Doxygen
13
14/**
15 * \defgroup stats Statistics
16 *
17 * The statistics module includes some useful features to ease data collection from experiments.
18 * In particular the following features are included:
19 * <ul>
20 * <li> The core framework and two basic data collectors: A counter, and a min/max/avg/total
21 * observer.</li> <li> Extensions of those to easily work with times and packets.</li> <li>
22 * Plaintext output formatted for OMNet++.</li> <li> Database output using SQLite, a standalone,
23 * lightweight, high performance SQL engine.</li> <li> Mandatory and open ended metadata for
24 * describing and working with runs.</li>
25 * </ul>
26 *
27 * See the manual for a complete documentation.
28 */
29
30/**
31 * \ingroup stats
32 * \defgroup aggregator Data Aggregators
33 *
34 * Data aggregators are classes used to collect data and produce output
35 * specialized for various purpose, e.g., Gnuplot, file output, etc.
36 */
37
38/**
39 * \ingroup stats
40 * \defgroup probes Probes
41 *
42 * Probes are used to probe an underlying ns3 TraceSource exporting
43 * its value. This probe usually exports a trace source "Output".
44 * The Output trace source emits a value when either the trace source
45 * emits a new value, or when SetValue () is called.
46 *
47 * Probes are a special kind of Trace Source.
48 */
49
50/**
51 * \ingroup stats
52 * \defgroup gnuplot Gnuplot
53 *
54 * Classes in Gnuplot group are used to collect and prepare and output data
55 * for subsequent processing by Gnuplot.
56 */
57
58/**
59 * \ingroup stats
60 * \defgroup dataoutput Data Output
61 *
62 * Classes in Data Output group are used to collect and prepare and output data
63 * for subsequent output in a specific format, e.g., Omnet++, SQLite, etc.
64 */
65
66/**
67 * \ingroup stats
68 * \ingroup tests
69 * \defgroup stats-tests Statistics module tests
70 */
71
72#endif /* STATS_H */