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