A Discrete-Event Network Simulator
API
time-data-calculators.cc
Go to the documentation of this file.
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 #include "ns3/log.h"
22 #include "ns3/nstime.h"
23 
24 #include "time-data-calculators.h"
25 
26 using namespace ns3;
27 
28 NS_LOG_COMPONENT_DEFINE ("TimeDataCalculators");
29 
30 //--------------------------------------------------------------
31 //----------------------------------------------
33 {
34  NS_LOG_FUNCTION (this);
35 
36  m_count = 0;
37 }
39 {
40  NS_LOG_FUNCTION (this);
41 }
42 /* static */
43 TypeId
45 {
46  static TypeId tid = TypeId ("ns3::TimeMinMaxAvgTotalCalculator")
48  .SetGroupName ("Stats")
49  .AddConstructor<TimeMinMaxAvgTotalCalculator> ();
50  return tid;
51 }
52 
53 void
55 {
56  NS_LOG_FUNCTION (this);
57 
59  // TimeMinMaxAvgTotalCalculator::DoDispose
60 }
61 
62 void
64 {
65  NS_LOG_FUNCTION (this << i);
66 
67  if (m_enabled) {
68  if (m_count) {
69  m_total += i;
70 
71  if (i < m_min)
72  m_min = i;
73 
74  if (i > m_max)
75  m_max = i;
76 
77  } else {
78  m_min = i;
79  m_max = i;
80  m_total = i;
81  }
82  m_count++;
83 
84  }
85  // end TimeMinMaxAvgTotalCalculator::Update
86 }
87 void
89 {
90  NS_LOG_FUNCTION (this << &callback);
91 
92  callback.OutputSingleton (m_context, m_key + "-count", m_count);
93  if (m_count > 0) {
94  callback.OutputSingleton (m_context, m_key + "-total", m_total);
95  callback.OutputSingleton (m_context, m_key + "-average", Time (m_total / m_count));
96  callback.OutputSingleton (m_context, m_key + "-max", m_max);
97  callback.OutputSingleton (m_context, m_key + "-min", m_min);
98  }
99  // end TimeMinMaxAvgTotalCalculator::Output
100 }
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:201
bool m_enabled
Descendant classes must check & respect m_enabled!
virtual void DoDispose(void)
Destructor implementation.
virtual void Output(DataOutputCallback &callback) const
Outputs data based on the provided callback.
Unfortunately, templating the base MinMaxAvgTotalCalculator to operate over Time values isn't straigh...
virtual void DoDispose(void)
Destructor implementation.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
uint32_t m_count
Count value of TimeMinMaxAvgTotalCalculator.
Callback class for the DataOutput classes.
static TypeId GetTypeId(void)
Register this type.
std::string m_context
Context value.
Calculates data during a simulation.
Time m_min
Minimum value of TimeMinMaxAvgTotalCalculator.
Time m_total
Total value of TimeMinMaxAvgTotalCalculator.
void Update(const Time i)
Updates all variables of TimeMinMaxAvgTotalCalculator.
Time m_max
Maximum value of TimeMinMaxAvgTotalCalculator.
virtual void OutputSingleton(std::string key, std::string variable, int val)=0
Associates the integer value with the variable name for a specific output format. ...
a unique identifier for an interface.
Definition: type-id.h:58
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:904
std::string m_key
Key value.