1 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2008 Drexel University
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: Joe Kopena (tjkopena@cs.drexel.edu)
19  */
20 
21 #ifndef TIME_DATA_CALCULATORS_H
22 #define TIME_DATA_CALCULATORS_H
23 
24 #include "ns3/nstime.h"
25 
26 #include "data-calculator.h"
27 #include "data-output-interface.h"
28 
29 namespace ns3 {
30 
31 //------------------------------------------------------------
32 //--------------------------------------------
33 /**
34  * \ingroup stats
35  *
36  * Unfortunately, templating the base MinMaxAvgTotalCalculator to
37  * operate over Time values isn't straightforward.  The main issues
38  * are setting the maximum value, which can be worked around easily
39  * as it done here, and dividing to get the average, which is not as
40  * easily worked around.
41 */
42 class TimeMinMaxAvgTotalCalculator : public DataCalculator {
43 public:
44   TimeMinMaxAvgTotalCalculator();
45   virtual ~TimeMinMaxAvgTotalCalculator();
46 
47   /**
48    * Register this type.
49    * \return The TypeId.
50    */
51   static TypeId GetTypeId (void);
52 
53   /**
54    * Updates all variables of TimeMinMaxAvgTotalCalculator
55    * \param i value of type Time to use for updating the calculator
56    */
57   void Update (const Time i);
58 
59   /**
60    * Outputs data based on the provided callback
61    * \param callback
62    */
63   virtual void Output (DataOutputCallback &callback) const;
64 
65 protected:
66   virtual void DoDispose (void);
67 
68   uint32_t m_count; //!< Count value of TimeMinMaxAvgTotalCalculator
69   Time m_total;     //!< Total value of TimeMinMaxAvgTotalCalculator
70   Time m_min;       //!< Minimum value of TimeMinMaxAvgTotalCalculator
71   Time m_max;       //!< Maximum value of TimeMinMaxAvgTotalCalculator
72 
73   // end class TimeMinMaxAvgTotalCalculator
74 };
75 
76 // end namespace ns3
77 };
78 
79 
80 #endif /* TIME_DATA_CALCULATORS_H */
81