View | Details | Raw Unified | Return to bug 938
Collapse All | Expand All

(-)a/src/stats/helper/file-helper.h (-2 / +3 lines)
 Lines 133-144    Link Here 
133
133
134
  /**
134
  /**
135
   * \param probeName the probe's name.
135
   * \param probeName the probe's name.
136
   *
136
   * \return Ptr to the probe
137
   * \brief Gets the specified probe.
137
   * \brief Gets the specified probe.
138
   */
138
   */
139
  Ptr<Probe> GetProbe (std::string probeName) const;
139
  Ptr<Probe> GetProbe (std::string probeName) const;
140
140
141
  /**
141
  /**
142
   * \return Ptr to a FileAggregator object
142
   * \brief Gets the single aggregator that is always constructed.
143
   * \brief Gets the single aggregator that is always constructed.
143
   *
144
   *
144
   * This function is non-const because an aggregator may be lazily
145
   * This function is non-const because an aggregator may be lazily
 Lines 149-155    Link Here 
149
  /**
150
  /**
150
   * \param aggregatorName name for aggregator.
151
   * \param aggregatorName name for aggregator.
151
   * \param outputFileName name of output file to write.
152
   * \param outputFileName name of output file to write.
152
   *
153
   * \return Ptr to a FileAggregator object
153
   * \brief Gets one of the multiple aggregators from the map.
154
   * \brief Gets one of the multiple aggregators from the map.
154
   *
155
   *
155
   * This function is non-const because an aggregator may be lazily
156
   * This function is non-const because an aggregator may be lazily
(-)a/src/stats/helper/gnuplot-helper.h (-1 / +2 lines)
 Lines 139-150    Link Here 
139
139
140
  /**
140
  /**
141
   * \param probeName the probe's name.
141
   * \param probeName the probe's name.
142
   *
142
   * \return Ptr to probe
143
   * \brief Gets the specified probe.
143
   * \brief Gets the specified probe.
144
   */
144
   */
145
  Ptr<Probe> GetProbe (std::string probeName) const;
145
  Ptr<Probe> GetProbe (std::string probeName) const;
146
146
147
  /**
147
  /**
148
   * \return Ptr to GnuplotAggregator object
148
   * \brief Gets the aggregator.
149
   * \brief Gets the aggregator.
149
   *
150
   *
150
   * This function is non-const because an aggregator may be lazily
151
   * This function is non-const because an aggregator may be lazily
(-)a/src/stats/model/basic-data-calculators.h (-11 / +73 lines)
 Lines 31-36    Link Here 
31
 *
31
 *
32
 */
32
 */
33
33
34
/**
35
 * \ingroup stats
36
 * \class MinMaxAvgTotalCalculator
37
 * \brief Template class MinMaxAvgTotalCalculator
38
 *
39
 */
34
//------------------------------------------------------------
40
//------------------------------------------------------------
35
//--------------------------------------------
41
//--------------------------------------------
36
template <typename T  = uint32_t>
42
template <typename T  = uint32_t>
 Lines 40-75    Link Here 
40
  MinMaxAvgTotalCalculator();
46
  MinMaxAvgTotalCalculator();
41
  virtual ~MinMaxAvgTotalCalculator();
47
  virtual ~MinMaxAvgTotalCalculator();
42
48
49
  /**
50
   * Updates all variables of MinMaxAvgTotalCalculator
51
   * \param i value of type T to use for updating the calculator
52
   */
43
  void Update (const T i);
53
  void Update (const T i);
54
  /**
55
   * Reinitializes all variables of MinMaxAvgTotalCalculator
56
   */
44
  void Reset ();
57
  void Reset ();
45
58
46
  virtual void Output (DataOutputCallback &callback) const;
59
  virtual void Output (DataOutputCallback &callback) const;
47
60
61
  /**
62
   * Returns the count
63
   * \return Count
64
   */
48
  long getCount () const { return m_count; }
65
  long getCount () const { return m_count; }
66
  /**
67
   * Returns the sum
68
   * \return Total
69
   */
49
  double getSum () const { return m_total; }
70
  double getSum () const { return m_total; }
71
  /**
72
   * Returns the minimum value
73
   * \return Min
74
   */
50
  double getMin () const { return m_min; }
75
  double getMin () const { return m_min; }
76
  /**
77
   * Returns the maximum value
78
   * \return Max
79
   */
51
  double getMax () const { return m_max; }
80
  double getMax () const { return m_max; }
81
  /**
82
   * Returns the mean value
83
   * \return Mean
84
   */
52
  double getMean () const { return m_meanCurr; }
85
  double getMean () const { return m_meanCurr; }
86
  /**
87
   * Returns the standard deviation
88
   * \return Standard deviation
89
   */
53
  double getStddev () const { return std::sqrt (m_varianceCurr); }
90
  double getStddev () const { return std::sqrt (m_varianceCurr); }
91
  /**
92
   * Returns the current variance
93
   * \return Variance
94
   */
54
  double getVariance () const { return m_varianceCurr; }
95
  double getVariance () const { return m_varianceCurr; }
96
  /**
97
   * Returns the sum of squares
98
   * \return Sum of squares
99
   */
55
  double getSqrSum () const { return m_squareTotal; }
100
  double getSqrSum () const { return m_squareTotal; }
56
101
57
protected:
102
protected:
58
  virtual void DoDispose (void);
103
  virtual void DoDispose (void);
59
104
60
  uint32_t m_count;
105
  uint32_t m_count;      /// Count value of MinMaxAvgTotalCalculator
61
106
62
  T m_total;
107
  T m_total;             /// Total value of MinMaxAvgTotalCalculator
63
  T m_squareTotal;
108
  T m_squareTotal;       /// Sum of squares value of MinMaxAvgTotalCalculator
64
  T m_min;
109
  T m_min;               /// Minimum value of MinMaxAvgTotalCalculator
65
  T m_max;
110
  T m_max;               /// Maximum value of MinMaxAvgTotalCalculator
66
111
67
  double m_meanCurr;
112
  double m_meanCurr;     /// Current mean of MinMaxAvgTotalCalculator
68
  double m_sCurr;
113
  double m_sCurr;        /// Current s of MinMaxAvgTotalCalculator
69
  double m_varianceCurr;
114
  double m_varianceCurr; /// Current variance of MinMaxAvgTotalCalculator
70
115
71
  double m_meanPrev;
116
  double m_meanPrev;     /// Previous mean of MinMaxAvgTotalCalculator
72
  double m_sPrev;
117
  double m_sPrev;        /// Previous s of MinMaxAvgTotalCalculator
73
118
74
  // end MinMaxAvgTotalCalculator
119
  // end MinMaxAvgTotalCalculator
75
};
120
};
 Lines 197-202    Link Here 
197
242
198
/**
243
/**
199
 * \ingroup stats
244
 * \ingroup stats
245
 * \class CounterCalculator
246
 * \brief Template class CounterCalculator
200
 *
247
 *
201
 */
248
 */
202
//------------------------------------------------------------
249
//------------------------------------------------------------
 Lines 207-223    Link Here 
207
  CounterCalculator();
254
  CounterCalculator();
208
  virtual ~CounterCalculator();
255
  virtual ~CounterCalculator();
209
256
257
  /**
258
   * Increments count by 1
259
   */
210
  void Update ();
260
  void Update ();
261
  /**
262
   * Increments count by i
263
   * \param i value of type T to increment count
264
   */
211
  void Update (const T i);
265
  void Update (const T i);
212
266
267
  /**
268
   * Returns the count of the CounterCalculator
269
   * \return Count as a value of type T
270
   */
213
  T GetCount () const;
271
  T GetCount () const;
214
272
273
  /**
274
   * Outputs the data based on the provided callback
275
   * \param callback
276
   */
215
  virtual void Output (DataOutputCallback &callback) const;
277
  virtual void Output (DataOutputCallback &callback) const;
216
278
217
protected:
279
protected:
218
  virtual void DoDispose (void);
280
  virtual void DoDispose (void);
219
281
220
  T m_count;
282
  T m_count; /// Count value of CounterCalculator
221
283
222
  // end CounterCalculator
284
  // end CounterCalculator
223
};
285
};
(-)a/src/stats/model/data-calculator.h (-5 / +72 lines)
 Lines 26-36    Link Here 
26
#include "ns3/simulator.h"
26
#include "ns3/simulator.h"
27
27
28
namespace ns3 {
28
namespace ns3 {
29
extern const double NaN;
29
30
extern const double NaN; /// Stored representation of NaN
31
32
/**
33
 * \brief true if x is NaN
34
 * \param x
35
 * \return whether x is NaN
36
 */
30
inline bool isNaN (double x) { return x != x; }
37
inline bool isNaN (double x) { return x != x; }
31
38
32
class DataOutputCallback;
39
class DataOutputCallback;
33
40
41
/**
42
 * \ingroup stats
43
 * \class StatisticalSummary
44
 * \brief Abstract class for calculating statistical data 
45
 *
46
 */
34
class StatisticalSummary {
47
class StatisticalSummary {
35
public:
48
public:
36
  /**
49
  /**
 Lines 40-87    Link Here 
40
  {
53
  {
41
  }
54
  }
42
  /**
55
  /**
43
   * Returns the number of the observations.
56
   * Returns the number of observations.
57
   * \return Number of observations
44
   */
58
   */
45
  virtual long getCount () const = 0;
59
  virtual long getCount () const = 0;
46
60
47
  /**
61
  /**
48
   * Returns the sum of the values.
62
   * Returns the sum of the values.
63
   * \return Sum of values
49
   * @see getWeightedSum()
64
   * @see getWeightedSum()
50
   */
65
   */
51
  virtual double getSum () const = 0;
66
  virtual double getSum () const = 0;
52
67
53
  /**
68
  /**
54
   * Returns the sum of the squared values.
69
   * Returns the sum of the squared values.
70
   * \return Sum of squared values
55
   * @see getWeightedSqrSum()
71
   * @see getWeightedSqrSum()
56
   */
72
   */
57
  virtual double getSqrSum () const = 0;
73
  virtual double getSqrSum () const = 0;
58
74
59
  /**
75
  /**
60
   * Returns the minimum of the values.
76
   * Returns the minimum of the values.
77
   * \return Minimum of values
61
   */
78
   */
62
  virtual double getMin () const = 0;
79
  virtual double getMin () const = 0;
63
80
64
  /**
81
  /**
65
   * Returns the maximum of the values.
82
   * Returns the maximum of the values.
83
   * \return Maximum of values
66
   */
84
   */
67
  virtual double getMax () const = 0;
85
  virtual double getMax () const = 0;
68
86
69
  /**
87
  /**
70
   * Returns the mean of the (weighted) observations.
88
   * Returns the mean of the (weighted) observations.
89
   * \return Mean of (weighted) observations
71
   */
90
   */
72
  virtual double getMean () const = 0;
91
  virtual double getMean () const = 0;
73
92
74
  /**
93
  /**
75
   * Returns the standard deviation of the (weighted) observations.
94
   * Returns the standard deviation of the (weighted) observations.
95
   * \return Standard deviation of (weighted) observations
76
   */
96
   */
77
  virtual double getStddev () const = 0;
97
  virtual double getStddev () const = 0;
78
98
79
  /**
99
  /**
80
   * Returns the variance of the (weighted) observations.
100
   * Returns the variance of the (weighted) observations.
101
   * \return Variance of (weighted) observations
81
   */
102
   */
82
  virtual double getVariance () const = 0;
103
  virtual double getVariance () const = 0;
83
};
104
};
84
105
106
/**
107
 * \ingroup stats
108
 * \class DataCalculator
109
 * \brief Calculates data during a simulation
110
 *
111
 */
85
//------------------------------------------------------------
112
//------------------------------------------------------------
86
//--------------------------------------------
113
//--------------------------------------------
87
class DataCalculator : public Object {
114
class DataCalculator : public Object {
 Lines 89-114    Link Here 
89
  DataCalculator();
116
  DataCalculator();
90
  virtual ~DataCalculator();
117
  virtual ~DataCalculator();
91
118
119
  /**
120
   * Returns whether the DataCalculator is enabled
121
   * \return true if DataCalculator is enabled
122
   */
92
  bool GetEnabled () const;
123
  bool GetEnabled () const;
124
125
  /**
126
   * Enables DataCalculator when simulation starts
127
   */
93
  void Enable ();
128
  void Enable ();
129
130
  /**
131
   * Disables DataCalculator when simulation stops
132
   */
94
  void Disable ();
133
  void Disable ();
95
134
135
  /**
136
   * Sets the DataCalculator key to the provided key
137
   * \param key Key value as a string
138
   */
96
  void SetKey (const std::string key);
139
  void SetKey (const std::string key);
140
  /**
141
   * Gets the DataCalculator key
142
   * \return Key value as a string
143
   */
97
  std::string GetKey () const;
144
  std::string GetKey () const;
98
145
146
  /**
147
   * Sets the DataCalculator context to the provided context
148
   * \param context Context value as a string
149
   */
99
  void SetContext (const std::string context);
150
  void SetContext (const std::string context);
151
  /**
152
   * Gets the DataCalculator context
153
   * \return Context value as a string
154
   */
100
  std::string GetContext () const;
155
  std::string GetContext () const;
101
156
157
  /**
158
   * Starts DataCalculator at a given time in the simulation
159
   * \param startTime
160
   */
102
  virtual void Start (const Time& startTime);
161
  virtual void Start (const Time& startTime);
162
  /**
163
   * Stops DataCalculator at a given time in the simulation
164
   * \param stopTime
165
   */
103
  virtual void Stop (const Time& stopTime);
166
  virtual void Stop (const Time& stopTime);
104
167
168
  /**
169
   * Outputs data based on the provided callback
170
   * \param callback
171
   */
105
  virtual void Output (DataOutputCallback &callback) const = 0;
172
  virtual void Output (DataOutputCallback &callback) const = 0;
106
173
107
protected:
174
protected:
108
  bool m_enabled;    // Descendant classes *must* check & respect m_enabled!
175
  bool m_enabled;    /// Descendant classes *must* check & respect m_enabled!
109
176
110
  std::string m_key;
177
  std::string m_key;     /// Key value
111
  std::string m_context;
178
  std::string m_context; /// Context value
112
179
113
  virtual void DoDispose (void);
180
  virtual void DoDispose (void);
114
181
(-)a/src/stats/model/data-collection-object.h (-1 / +2 lines)
 Lines 40-47    Link Here 
40
  DataCollectionObject ();
40
  DataCollectionObject ();
41
  virtual ~DataCollectionObject ();
41
  virtual ~DataCollectionObject ();
42
42
43
  /// Set the status of an individual object. 
43
  /// Set the status of an individual object.
44
  void Enable (void);
44
  void Enable (void);
45
  /// Unset the status of an individual object.
45
  void Disable (void);
46
  void Disable (void);
46
47
47
  /// Check the status of an individual object.
48
  /// Check the status of an individual object.
(-)a/src/stats/model/data-collector.h (-1 / +71 lines)
 Lines 36-73    Link Here 
36
36
37
//------------------------------------------------------------
37
//------------------------------------------------------------
38
//--------------------------------------------
38
//--------------------------------------------
39
/**
40
 * List of Ptrs to DataCalculator objects
41
 */
39
typedef std::list<Ptr<DataCalculator> > DataCalculatorList;
42
typedef std::list<Ptr<DataCalculator> > DataCalculatorList;
43
/**
44
 * List of pairs of strings representing metadata
45
 */
40
typedef std::list<std::pair<std::string, std::string> > MetadataList;
46
typedef std::list<std::pair<std::string, std::string> > MetadataList;
41
47
42
/**
48
/**
43
 * \ingroup stats
49
 * \ingroup stats
44
 *
50
 * \class DataCollector
51
 * \brief Collects data 
45
 */
52
 */
46
class DataCollector : public Object {
53
class DataCollector : public Object {
47
public:
54
public:
48
  DataCollector();
55
  DataCollector();
49
  virtual ~DataCollector();
56
  virtual ~DataCollector();
50
57
58
  /**
59
   * Provide specific parameters to the DataCollector
60
   * \param experiment Label for the experiment
61
   * \param strategy Label for the strategy
62
   * \param input Label for the input
63
   * \param runID Label for the runID
64
   * \param description Description
65
   */
51
  void DescribeRun (std::string experiment,
66
  void DescribeRun (std::string experiment,
52
                    std::string strategy,
67
                    std::string strategy,
53
                    std::string input,
68
                    std::string input,
54
                    std::string runID,
69
                    std::string runID,
55
                    std::string description = "");
70
                    std::string description = "");
56
71
72
  /**
73
   * Return the experiment label
74
   * \return Experiment label
75
   */
57
  std::string GetExperimentLabel () const { return m_experimentLabel; }
76
  std::string GetExperimentLabel () const { return m_experimentLabel; }
77
  /**
78
   * Return the strategy label
79
   * \return Strategy label
80
   */
58
  std::string GetStrategyLabel () const { return m_strategyLabel; }
81
  std::string GetStrategyLabel () const { return m_strategyLabel; }
82
  /**
83
   * Return the input label
84
   * \return Input label
85
   */
59
  std::string GetInputLabel () const { return m_inputLabel; }
86
  std::string GetInputLabel () const { return m_inputLabel; }
87
  /**
88
   * Return the runID label
89
   * \return Run label
90
   */
60
  std::string GetRunLabel () const { return m_runLabel; }
91
  std::string GetRunLabel () const { return m_runLabel; }
92
  /**
93
   * Return the description label
94
   * \return Description label
95
   */
61
  std::string GetDescription () const { return m_description; }
96
  std::string GetDescription () const { return m_description; }
62
97
98
  /**
99
   * Add the key and the value as a pair of strings to the metadata list
100
   * \param key Key value to include
101
   * \param value Value to include of type string
102
   */
63
  void AddMetadata (std::string key, std::string value);
103
  void AddMetadata (std::string key, std::string value);
104
  /**
105
   * Add the key and the value as a pair of strings to the metadata list
106
   * \param key Key value to include
107
   * \param value Value to include of type double
108
   */
64
  void AddMetadata (std::string key, double value);
109
  void AddMetadata (std::string key, double value);
110
  /**
111
   * Add the key and the value as a pair of strings to the metadata list
112
   * \param key Key value to include
113
   * \param value Value to include of type uint32_t
114
   */
65
  void AddMetadata (std::string key, uint32_t value);
115
  void AddMetadata (std::string key, uint32_t value);
116
  /**
117
   * Returns an iterator to the beginning of the metadata list
118
   * \return Iterator pointing to the first value of the metadata list
119
   */
66
  MetadataList::iterator MetadataBegin ();
120
  MetadataList::iterator MetadataBegin ();
121
  /**
122
   * Returns an iterator to the past-the-end of the metadata list
123
   * \return Iterator pointing to the past-the-end element of the metadata list
124
   */
67
  MetadataList::iterator MetadataEnd ();
125
  MetadataList::iterator MetadataEnd ();
68
126
127
  /**
128
   * Add a DataCalculator object to the DataCollector
129
   * \param datac DataCalculator object to be added
130
   */
69
  void AddDataCalculator (Ptr<DataCalculator> datac);
131
  void AddDataCalculator (Ptr<DataCalculator> datac);
132
  /**
133
   * Returns an iterator to the beginning of the DataCalculator list
134
   * \return Iterator pointing to the first value of the DataCalculator list
135
   */
70
  DataCalculatorList::iterator DataCalculatorBegin ();
136
  DataCalculatorList::iterator DataCalculatorBegin ();
137
  /**
138
   * Returns an iterator to the past-the-end of the DataCalculator list
139
   * \return Iterator pointing to the past-the-end element of the DataCalculator list
140
   */
71
  DataCalculatorList::iterator DataCalculatorEnd ();
141
  DataCalculatorList::iterator DataCalculatorEnd ();
72
142
73
protected:
143
protected:
(-)a/src/stats/model/data-output-interface.h (-1 / +56 lines)
 Lines 33-38    Link Here 
33
//--------------------------------------------
33
//--------------------------------------------
34
/**
34
/**
35
 * \ingroup stats
35
 * \ingroup stats
36
 * \class DataCollector
37
 * \brief Abstract Data Output Interface class
36
 *
38
 *
37
 */
39
 */
38
class DataOutputInterface : public Object {
40
class DataOutputInterface : public Object {
 Lines 40-86    Link Here 
40
  DataOutputInterface();
42
  DataOutputInterface();
41
  virtual ~DataOutputInterface();
43
  virtual ~DataOutputInterface();
42
44
45
  /**
46
   * Outputs information from the provided DataCollector
47
   * \param dc DataCollector object
48
   */
43
  virtual void Output (DataCollector &dc) = 0;
49
  virtual void Output (DataCollector &dc) = 0;
44
50
51
  /**
52
   * Sets the DataOutputInterface prefix to the provided prefix
53
   * \param File prefix as a string
54
   */
45
  void SetFilePrefix (const std::string prefix);
55
  void SetFilePrefix (const std::string prefix);
56
  /**
57
   * Gets the file prefix of the DataOutputInterface
58
   * \return File prefix as a string
59
   */
46
  std::string GetFilePrefix () const;
60
  std::string GetFilePrefix () const;
47
61
48
protected:
62
protected:
49
  virtual void DoDispose ();
63
  virtual void DoDispose ();
50
64
51
  std::string m_filePrefix;
65
  std::string m_filePrefix; /// File prefix for the DataOutputInterface
52
66
53
  // end class DataOutputInterface
67
  // end class DataOutputInterface
54
};
68
};
55
69
56
/**
70
/**
57
 * \ingroup stats
71
 * \ingroup stats
72
 * \class DataOutputCallback
73
 * \brief Callback class for the DataOutput classes
58
 *
74
 *
59
 */
75
 */
60
class DataOutputCallback {
76
class DataOutputCallback {
61
public:
77
public:
78
  /**
79
   * Destructor
80
   */
62
  virtual ~DataOutputCallback() {}
81
  virtual ~DataOutputCallback() {}
63
82
83
  /**
84
   * Outputs the data from the specified StatisticalSummary
85
   * \param key Key value of a DataCalculator
86
   * \param variable Name of the variable for which statistics are being provided
87
   * \param statSum Pointer to a StatisticalSummary object
88
   */
64
  virtual void OutputStatistic (std::string key,
89
  virtual void OutputStatistic (std::string key,
65
                                std::string variable,
90
                                std::string variable,
66
                                const StatisticalSummary *statSum) = 0;
91
                                const StatisticalSummary *statSum) = 0;
67
92
93
  /**
94
   * Associates the integer value with the variable name for a specific output format
95
   * \param key Key value of a DataCalculator
96
   * \param variable Name of the variable for which statistics are being provided
97
   * \param val Value to be stored
98
   */
68
  virtual void OutputSingleton (std::string key,
99
  virtual void OutputSingleton (std::string key,
69
                                std::string variable,
100
                                std::string variable,
70
                                int val) = 0;
101
                                int val) = 0;
71
102
103
  /**
104
   * Associates the uint32_t value with the variable name for a specific output format
105
   * \param key Key value of a DataCalculator
106
   * \param variable Name of the variable for which statistics are being provided
107
   * \param val Value to be stored
108
   */
72
  virtual void OutputSingleton (std::string key,
109
  virtual void OutputSingleton (std::string key,
73
                                std::string variable,
110
                                std::string variable,
74
                                uint32_t val) = 0;
111
                                uint32_t val) = 0;
75
112
113
  /**
114
   * Associates the double value with the variable name for a specific output format
115
   * \param key Key value of a DataCalculator
116
   * \param variable Name of the variable for which statistics are being provided
117
   * \param val Value to be stored
118
   */
76
  virtual void OutputSingleton (std::string key,
119
  virtual void OutputSingleton (std::string key,
77
                                std::string variable,
120
                                std::string variable,
78
                                double val) = 0;
121
                                double val) = 0;
79
122
123
  /**
124
   * Associates the string value with the variable name for a specific output format
125
   * \param key Key value of a DataCalculator
126
   * \param variable Name of the variable for which statistics are being provided
127
   * \param val Value to be stored
128
   */
80
  virtual void OutputSingleton (std::string key,
129
  virtual void OutputSingleton (std::string key,
81
                                std::string variable,
130
                                std::string variable,
82
                                std::string val) = 0;
131
                                std::string val) = 0;
83
132
133
  /**
134
   * Associates the Time value with the variable name for a specific output format
135
   * \param key Key value of a DataCalculator
136
   * \param variable Name of the variable for which statistics are being provided
137
   * \param val Value to be stored
138
   */
84
  virtual void OutputSingleton (std::string key,
139
  virtual void OutputSingleton (std::string key,
85
                                std::string variable,
140
                                std::string variable,
86
                                Time val) = 0;
141
                                Time val) = 0;
(-)a/src/stats/model/get-wildcard-matches.h (+1 lines)
 Lines 30-35    Link Here 
30
 * \param matchedPath the path that matched the Config path.
30
 * \param matchedPath the path that matched the Config path.
31
 * \param wildcardSeparator the text to put betwen the wildcard
31
 * \param wildcardSeparator the text to put betwen the wildcard
32
 * matches.  By default, a space is used.
32
 * matches.  By default, a space is used.
33
 * \return String value of text matches
33
 *
34
 *
34
 * \brief Returns the text matches from the matched path for each of
35
 * \brief Returns the text matches from the matched path for each of
35
 * the wildcards in the Config path, separated by the wild card
36
 * the wildcards in the Config path, separated by the wild card
(-)a/src/stats/model/gnuplot.h (-1 / +6 lines)
 Lines 41-46    Link Here 
41
41
42
  /**
42
  /**
43
   * Reference-counting copy constructor.
43
   * Reference-counting copy constructor.
44
   * \param original Original GnuPlotDataset
44
   */
45
   */
45
  GnuplotDataset (const GnuplotDataset& original);
46
  GnuplotDataset (const GnuplotDataset& original);
46
47
 Lines 51-56    Link Here 
51
52
52
  /**
53
  /**
53
   * Reference-counting assignment operator.
54
   * Reference-counting assignment operator.
55
   * \param original Right-hand side of assignment operator
56
   * \return Copy of original GnuplotDataset
54
   */
57
   */
55
  GnuplotDataset& operator= (const GnuplotDataset& original);
58
  GnuplotDataset& operator= (const GnuplotDataset& original);
56
59
 Lines 101-106    Link Here 
101
};
104
};
102
105
103
/**
106
/**
107
 * \class Gnuplot2dDataset
104
 * \brief Class to represent a 2D points plot. Set the line or points style
108
 * \brief Class to represent a 2D points plot. Set the line or points style
105
 * using SetStyle() and set points using Add().
109
 * using SetStyle() and set points using Add().
106
 */
110
 */
 Lines 361-367    Link Here 
361
  /**
365
  /**
362
   * Crude attempt to auto-detect the correct terminal setting by inspecting
366
   * Crude attempt to auto-detect the correct terminal setting by inspecting
363
   * the filename's extension.
367
   * the filename's extension.
364
   * \param filename output file name
368
   * \param filename output filename
369
   * \return File extension of the provided filename
365
   */
370
   */
366
  static std::string DetectTerminal (const std::string& filename);
371
  static std::string DetectTerminal (const std::string& filename);
367
372
(-)a/src/stats/model/omnet-data-output.h (+2 lines)
 Lines 32-37    Link Here 
32
//--------------------------------------------
32
//--------------------------------------------
33
/**
33
/**
34
 * \ingroup stats
34
 * \ingroup stats
35
 * \class OmnetDataOutput
36
 * \brief Outputs data in a format compatible with OMNeT library and framework
35
 *
37
 *
36
 */
38
 */
37
class OmnetDataOutput : public DataOutputInterface {
39
class OmnetDataOutput : public DataOutputInterface {
(-)a/src/stats/model/sqlite-data-output.h (-1 / +2 lines)
 Lines 35-41    Link Here 
35
//--------------------------------------------
35
//--------------------------------------------
36
/**
36
/**
37
 * \ingroup stats
37
 * \ingroup stats
38
 *
38
 * \class SqliteDataOutput
39
 * \brief Outputs data in a format compatible with SQLite
39
 */
40
 */
40
class SqliteDataOutput : public DataOutputInterface {
41
class SqliteDataOutput : public DataOutputInterface {
41
public:
42
public:
(-)a/src/stats/model/time-data-calculators.h (-2 / +12 lines)
 Lines 44-58    Link Here 
44
  TimeMinMaxAvgTotalCalculator();
44
  TimeMinMaxAvgTotalCalculator();
45
  virtual ~TimeMinMaxAvgTotalCalculator();
45
  virtual ~TimeMinMaxAvgTotalCalculator();
46
46
47
  /**
48
   * Updates all variables of TimeMinMaxAvgTotalCalculator
49
   * \param i value of type Time to use for updating the calculator
50
   */
47
  void Update (const Time i);
51
  void Update (const Time i);
48
52
53
  /**
54
   * Outputs data based on the provided callback
55
   * \param callback
56
   */
49
  virtual void Output (DataOutputCallback &callback) const;
57
  virtual void Output (DataOutputCallback &callback) const;
50
58
51
protected:
59
protected:
52
  virtual void DoDispose (void);
60
  virtual void DoDispose (void);
53
61
54
  uint32_t m_count;
62
  uint32_t m_count; /// Count value of TimeMinMaxAvgTotalCalculator
55
  Time m_total, m_min, m_max;
63
  Time m_total;     /// Total value of TimeMinMaxAvgTotalCalculator
64
  Time m_min;       /// Minimum value of TimeMinMaxAvgTotalCalculator
65
  Time m_max;       /// Maximum value of TimeMinMaxAvgTotalCalculator
56
66
57
  // end class TimeMinMaxAvgTotalCalculator
67
  // end class TimeMinMaxAvgTotalCalculator
58
};
68
};

Return to bug 938