Attachment #1737 for bug #938

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

(-)a/src/core/helper/event-garbage-collector.h (-1 / +1 lines)

Lines 27-33	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup tools

 * \ingroup events

 * \brief An object that tracks scheduled events and automatically

 * \brief An object that tracks scheduled events and automatically

 * cancels them when it is destroyed.  It is useful in situations

 * cancels them when it is destroyed.  It is useful in situations




namespace ns3 {

/**
 * \ingroup stats
 * \brief Helper class used to put data values into a file.
 **/
class FileHelper

  /// Heading line for the outputfile.
  std::string m_heading;

  std::string m_1dFormat;  //!< Format string for 1D format C-style sprintf() function.
  std::string m_2dFormat;  //!< Format string for 2D format C-style sprintf() function.
  std::string m_3dFormat;  //!< Format string for 3D format C-style sprintf() function.
  std::string m_4dFormat;  //!< Format string for 4D format C-style sprintf() function.
  std::string m_5dFormat;  //!< Format string for 5D format C-style sprintf() function.
  std::string m_6dFormat;  //!< Format string for 6D format C-style sprintf() function.
  std::string m_7dFormat;  //!< Format string for 7D format C-style sprintf() function.
  std::string m_8dFormat;  //!< Format string for 8D format C-style sprintf() function.
  std::string m_9dFormat;  //!< Format string for 9D format C-style sprintf() function.
  std::string m_10dFormat; //!< Format string for 10D format C-style sprintf() function.
  std::string m_10dFormat;

}; // class FileHelper


(-)a/src/stats/helper/gnuplot-helper.h (+1 lines)

Lines 33-38	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup gnuplot

 * \brief Helper class used to make gnuplot plots.

 * \brief Helper class used to make gnuplot plots.

**/

**/

class GnuplotHelper

class GnuplotHelper




namespace ns3 {

/**
 * \ingroup stats
 *
 */

/**
 * \ingroup tools
 *
 * Simple average, min, max and std. deviation calculator
 *

  //\}

private:
  uint32_t m_size; //!< Number of sampled data.
  T m_min; //!< Minimum value observed.
  T m_max; //!< Maximum value observed.
  MinMaxAvgTotalCalculator<double> m_varianceCalculator; //!< Variance calculator.
};

/// Print avg (err) [min, max]




namespace ns3 {

/**
 * \defgroup stats Statistics
 *
 */

/**
 * \ingroup stats
 * \class MinMaxAvgTotalCalculator
 * \brief Template class MinMaxAvgTotalCalculator

protected:
  virtual void DoDispose (void);

  uint32_t m_count;      //!< Count value of MinMaxAvgTotalCalculator

  T m_total;             //!< Total value of MinMaxAvgTotalCalculator
  T m_squareTotal;       //!< Sum of squares value of MinMaxAvgTotalCalculator
  T m_min;               //!< Minimum value of MinMaxAvgTotalCalculator
  T m_max;               //!< Maximum value of MinMaxAvgTotalCalculator

  double m_meanCurr;     //!< Current mean of MinMaxAvgTotalCalculator
  double m_sCurr;        //!< Current s of MinMaxAvgTotalCalculator
  double m_varianceCurr; //!< Current variance of MinMaxAvgTotalCalculator

  double m_meanPrev;     //!< Previous mean of MinMaxAvgTotalCalculator
  double m_sPrev;        //!< Previous s of MinMaxAvgTotalCalculator

  // end MinMaxAvgTotalCalculator
};

protected:
  virtual void DoDispose (void);

  T m_count; //!< Count value of CounterCalculator

  // end CounterCalculator
};

(-)a/src/stats/model/boolean-probe.h (-1 / +7 lines)

Lines 34-39	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup probes

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * a bool.  This probe exports a trace source "Output" of type bool.

 * a bool.  This probe exports a trace source "Output" of type bool.

 * The Output trace source emits a value when either the trace source

 * The Output trace source emits a value when either the trace source

Lines 45-50	Link Here

class BooleanProbe : public Probe

class BooleanProbe : public Probe

public:

public:

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId ();

  static TypeId GetTypeId ();

  BooleanProbe ();

  BooleanProbe ();

  virtual ~BooleanProbe ();

  virtual ~BooleanProbe ();

Lines 97-103	Link Here

*/

103

*/

  void TraceSink (bool oldData, bool newData);

104

  void TraceSink (bool oldData, bool newData);

105

100

  TracedValue<bool> m_output;

106

  TracedValue<bool> m_output; //!< Output trace source.

101

};

107

};

102

108

103

} // namespace ns3

109

} // namespace ns3




#include "ns3/simulator.h"

namespace ns3 {
extern const double NaN; //!< Stored representation of NaN

/**
 * \brief true if x is NaN

  virtual void Output (DataOutputCallback &callback) const = 0;

protected:
  bool m_enabled;    //!< Descendant classes *must* check & respect m_enabled!

  std::string m_key;      //!< Key value
  std::string m_context;  //!< Context value

  virtual void DoDispose (void);

private:
  EventId m_startEvent; //!< Start event
  EventId m_stopEvent;  //!< Stop event

  // end class DataCalculator
};

(-)a/src/stats/model/data-collection-object.h (+6 lines)

Lines 27-32	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup aggregator

 * Base class for data collection framework objects.

 * Base class for data collection framework objects.

 * All data collection objects have 1) a string name, and 2) enabled

 * All data collection objects have 1) a string name, and 2) enabled

Lines 35-40	Link Here

class DataCollectionObject : public Object

class DataCollectionObject : public Object

public:

public:

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId ();

  static TypeId GetTypeId ();

  DataCollectionObject ();

  DataCollectionObject ();





namespace ns3 {

/**
 * \ingroup stats
 *
 */
class DataCalculator;

//------------------------------------------------------------

typedef std::list<std::pair<std::string, std::string> > MetadataList;

/**
 * \ingroup dataoutput
 * \class DataCollector
 * \brief Collects data 
 */

  virtual void DoDispose ();

private:
  std::string m_experimentLabel; //!< Experiment label
  std::string m_strategyLabel;   //!< Strategy label
  std::string m_inputLabel;      //!< Input label
  std::string m_runLabel;        //!< Run label
  std::string m_description;     //!< Description label

  MetadataList m_metadata;       //!< List of experiment metadata
  DataCalculatorList m_calcList; //!< List of data calculators

  // end class DataCollector
};




//------------------------------------------------------------
//--------------------------------------------
/**
 * \ingroup dataoutput
 *
 * \brief Abstract Data Output Interface class
s */
 */
class DataOutputInterface : public Object {
public:
  DataOutputInterface();


  /**
   * Sets the DataOutputInterface prefix to the provided prefix
   * \param prefix prefix as a string
   */
  void SetFilePrefix (const std::string prefix);
  /**

protected:
  virtual void DoDispose ();

  std::string m_filePrefix; //!< File prefix for the DataOutputInterface

  // end class DataOutputInterface
};

/**
 * \ingroup dataoutput
 *
 * \brief Callback class for the DataOutput classes
 *
 */

(-)a/src/stats/model/double-probe.h (-3 / +7 lines)

Lines 34-39	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup probes

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * a double.  This probe exports a trace source "Output" of type double.

 * a double.  This probe exports a trace source "Output" of type double.

 * The Output trace source emits a value when either the trace source

 * The Output trace source emits a value when either the trace source

Lines 45-50	Link Here

class DoubleProbe : public Probe

class DoubleProbe : public Probe

public:

public:

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId ();

  static TypeId GetTypeId ();

  DoubleProbe ();

  DoubleProbe ();

  virtual ~DoubleProbe ();

  virtual ~DoubleProbe ();

Lines 92-103	Link Here

   * \param oldData previous value of the double

   * \param oldData previous value of the double

   * \param newData new value of the double

100

   * \param newData new value of the double

   * \internal

*/

101

*/

  void TraceSink (double oldData, double newData);

102

  void TraceSink (double oldData, double newData);

103

100

  TracedValue<double> m_output;

104

  TracedValue<double> m_output; //!< Output trace source.

101

};

105

};

102

106

103

} // namespace ns3

107

} // namespace ns3

(-)a/src/stats/model/file-aggregator.h (-11 / +16 lines)

Lines 32-37	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup aggregator

 * This aggregator sends values it receives to a file.

 * This aggregator sends values it receives to a file.

**/

**/

class FileAggregator : public DataCollectionObject

class FileAggregator : public DataCollectionObject

Lines 46-51	Link Here

    TAB_SEPARATED

    TAB_SEPARATED

};

};

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId ();

  static TypeId GetTypeId ();

/**

/**

Lines 364-380	Link Here

364

  /// Heading line for the outputfile.

370

  /// Heading line for the outputfile.

365

  std::string m_heading;

371

  std::string m_heading;

366

372

367

  /// Format strings for C-style sprintf() function.

373

  std::string m_1dFormat;  //!< Format string for 1D C-style sprintf() function.

368

  std::string m_1dFormat;

374

  std::string m_2dFormat;  //!< Format string for 2D C-style sprintf() function.

369

  std::string m_2dFormat;

375

  std::string m_3dFormat;  //!< Format string for 3D C-style sprintf() function.

370

  std::string m_3dFormat;

376

  std::string m_4dFormat;  //!< Format string for 4D C-style sprintf() function.

371

  std::string m_4dFormat;

377

  std::string m_5dFormat;  //!< Format string for 5D C-style sprintf() function.

372

  std::string m_5dFormat;

378

  std::string m_6dFormat;  //!< Format string for 6D C-style sprintf() function.

373

  std::string m_6dFormat;

379

  std::string m_7dFormat;  //!< Format string for 7D C-style sprintf() function.

374

  std::string m_7dFormat;

380

  std::string m_8dFormat;  //!< Format string for 8D C-style sprintf() function.

375

  std::string m_8dFormat;

381

  std::string m_9dFormat;  //!< Format string for 9D C-style sprintf() function.

376

  std::string m_9dFormat;

382

  std::string m_10dFormat; //!< Format string for 10D C-style sprintf() function.

377

  std::string m_10dFormat;

378

383

379

}; // class FileAggregator

384

}; // class FileAggregator

380

385

(-)a/src/stats/model/gnuplot-aggregator.h (+5 lines)

Lines 32-37	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup aggregator

 * This aggregator produces output used to make gnuplot plots.

 * This aggregator produces output used to make gnuplot plots.

**/

**/

class GnuplotAggregator : public DataCollectionObject

class GnuplotAggregator : public DataCollectionObject

Lines 46-51	Link Here

    KEY_BELOW

    KEY_BELOW

};

};

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId ();

  static TypeId GetTypeId ();

/**

/**





// --- GnuplotDataset::Data ------------------------------------------------ //

/**
 * \ingroup gnuplot
 *
 * Structure storing the data to plot.
 * Derived classes subclass this struct and add their own data fields.
 */
struct GnuplotDataset::Data
{
  // *** Data Variables ***

  unsigned int m_references; //!< ref/unref counter for garbage collection

  std::string m_title; //!< Dataset title
  std::string m_extra; //!< Extra parameters for the plot

  /**
   * Initializes the reference counter to 1 and sets m_title and m_extra.
   * \param title Dataset title
   */
  Data(const std::string& title);


  virtual ~Data();

  /**
   * \brief Returns the plot type ("plot" or "splot").
   * \returns the plot type ("plot" or "splot").
   */
  virtual std::string GetCommand () const = 0;


   * If more than one output file is being generated, i.e. separate
   * data and control files, then the index for the current dataset
   * and the name for the data file are also included.
   *
   * \param os Output stream
   * \param generateOneOutputFile If true, generate only one output file.
   * \param dataFileDatasetIndex Dataset Index
   * \param dataFileName Dataset file name
   */
  virtual void PrintExpression (std::ostream &os,
                                bool generateOneOutputFile,

  /**
   * Print the inline data file contents trailing the plot command. Empty for
   * functions.
   *
   * \param os Output stream
   * \param generateOneOutputFile If true, generate only one output file.
   */
  virtual void PrintDataFile (std::ostream &os, bool generateOneOutputFile) const = 0;



// --- Gnuplot2dDataset::Data2d -------------------------------------------- //

/**
 * \ingroup gnuplot
 *
 * Structure storing the data to for a 2D plot.
 */
struct Gnuplot2dDataset::Data2d : public GnuplotDataset::Data
{
  // *** Data Variables ***

  enum Style  m_style; //!< The plotting style to use for this dataset.
  enum ErrorBars m_errorBars; //!< Whether errorbars should be used for this dataset.

  PointSet    m_pointset; //!< The set of points in this data set

  /**
   * Initializes with the values from m_defaultStyle and m_defaultErrorBars.
   * \param title Dataset title
   */
  Data2d(const std::string& title);



// --- Gnuplot2dFunction::Function2d --------------------------------------- //

/**
 * \ingroup gnuplot
 *
 * Structure storing the function to be used for a 2D plot.
 */
struct Gnuplot2dFunction::Function2d : public GnuplotDataset::Data
{
  // *** Data Variables ***

  std::string m_function; //!< Function to use

  /**
   * Initializes with the function and title.
   *
   * \param title Title of the plot
   * \param function Function to plot
   */
  Function2d(const std::string& title, const std::string& function);



// --- Gnuplot3dDataset::Data3d -------------------------------------------- //

/**
 * \ingroup gnuplot
 *
 * Structure storing the data for a 3D plot.
 */
struct Gnuplot3dDataset::Data3d : public GnuplotDataset::Data
{
  // *** Data Variables ***

  std::string   m_style; //!< The plotting style to use for this dataset.

  PointSet      m_pointset; //!< The set of points in this data set

  /**
   * Initializes with value from m_defaultStyle.
   * \param title Dataset title
   */
  Data3d(const std::string& title);



// --- Gnuplot3dFunction::Function3d --------------------------------------- //

/**
 * \ingroup gnuplot
 *
 * Structure storing the function to be used for a 3D plot.
 */
struct Gnuplot3dFunction::Function3d : public GnuplotDataset::Data
{
  // *** Data Variables ***

  std::string m_function; //!< Function to use

  /**
   * Initializes with the function and title.
   *
   * \param title Title of the plot
   * \param function Function to plot
   */
  Function3d(const std::string& title, const std::string& function);


(-)a/src/stats/model/gnuplot.h (-23 / +47 lines)

Lines 28-34	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup tools

 * \ingroup gnuplot

 * \brief Abstract class to store a plot line to be used by ns3::Gnuplot.

 * \brief Abstract class to store a plot line to be used by ns3::Gnuplot.

Lines 104-109	Link Here

104

};

104

};

105

106

/**

106

/**

107

 * \ingroup gnuplot

108

107

 * \class Gnuplot2dDataset

109

 * \class Gnuplot2dDataset

108

 * \brief Class to represent a 2D points plot. Set the line or points style

110

 * \brief Class to represent a 2D points plot. Set the line or points style

109

 * using SetStyle() and set points using Add().

111

 * using SetStyle() and set points using Add().

Lines 205-228	Link Here

205

207

206

private:

208

private:

207

209

210

/**

211

   * A point in a 2D plot

212

*/

208

  struct Point {

213

  struct Point {

209

    bool empty;

214

    bool empty; //!< the point is empty

210

    double x;

215

    double x; //!< X coordinate

211

    double y;

216

    double y; //!< Y coordinate

212

    double dx;

217

    double dx; //!< X error delta

213

    double dy;

218

    double dy; //!< Y error delta

214

};

219

};

215

220

221

  /// The set of points in the dataset

216

  typedef std::vector<struct Point> PointSet;

222

  typedef std::vector<struct Point> PointSet;

217

223

218

  static enum Style m_defaultStyle;

224

  static enum Style m_defaultStyle; //!< default plot style

219

  static enum ErrorBars m_defaultErrorBars;

225

  static enum ErrorBars m_defaultErrorBars;  //!< default error bars type

220

226

221

  /// Forward declaration of the internal data class.

227

  /// Forward declaration of the internal data class.

222

  struct Data2d;

228

  struct Data2d;

223

};

229

};

224

230

225

/**

231

/**

232

 * \ingroup gnuplot

233

226

 * \brief Class to represent a 2D function expression plot.

234

 * \brief Class to represent a 2D function expression plot.

227

235

228

 * Since the function expression is not escaped, styles and extras could just

236

 * Since the function expression is not escaped, styles and extras could just

Lines 252-257	Link Here

252

};

260

};

253

261

254

/**

262

/**

263

 * \ingroup gnuplot

264

255

 * \brief Class to represent a 3D points plot. Set the line or points style

265

 * \brief Class to represent a 3D points plot. Set the line or points style

256

 * using SetStyle() and set points using Add().

266

 * using SetStyle() and set points using Add().

257

*/

267

*/

Lines 294-313	Link Here

294

304

295

private:

305

private:

296

306

307

/**

308

   * A point in a 3D plot

309

*/

297

  struct Point {

310

  struct Point {

298

    bool empty;

311

    bool empty; //!< the point is empty

299

    double x, y, z;

312

    double x; //!< X coordinate

313

    double y; //!< Y coordinate

314

    double z; //!< Z coordinate

300

};

315

};

301

316

317

  /// The set of points in the dataset

302

  typedef std::vector<struct Point> PointSet;

318

  typedef std::vector<struct Point> PointSet;

303

319

304

  static std::string m_defaultStyle;

320

  static std::string m_defaultStyle; //!< default plot style

305

321

306

  /// Forward declaration of the internal data class.

322

  /// Forward declaration of the internal data class.

307

  struct Data3d;

323

  struct Data3d;

308

};

324

};

309

325

310

/**

326

/**

327

 * \ingroup gnuplot

328

311

 * \brief Class to represent a 3D function expression plot.

329

 * \brief Class to represent a 3D function expression plot.

312

330

313

 * Since the function expression is not escaped, styles and extras could just as

331

 * Since the function expression is not escaped, styles and extras could just as

Lines 338-343	Link Here

338

};

356

};

339

357

340

/**

358

/**

359

 * \ingroup gnuplot

360

341

 * \brief a simple class to generate gnuplot-ready plotting commands

361

 * \brief a simple class to generate gnuplot-ready plotting commands

342

 *        from a set of datasets.

362

 *        from a set of datasets.

343

363

Lines 436-459	Link Here

436

  void SetDataFileDatasetIndex (unsigned int index);

456

  void SetDataFileDatasetIndex (unsigned int index);

437

457

438

private:

458

private:

459

  /// Type for Datasets to be used in plots

439

  typedef std::vector<GnuplotDataset> Datasets;

460

  typedef std::vector<GnuplotDataset> Datasets;

440

461

441

  std::string m_outputFilename;

462

  std::string m_outputFilename; //!< Output file name

442

  std::string m_terminal;

463

  std::string m_terminal; //!< Gnuplot "terminal" to use

443

464

444

  Datasets m_datasets;

465

  Datasets m_datasets; //!< Data sets

445

466

446

  std::string m_title;

467

  std::string m_title; //!< Plot title

447

  std::string m_xLegend;

468

  std::string m_xLegend; //!< X axis legend

448

  std::string m_yLegend;

469

  std::string m_yLegend; //!< Y axis legend

449

  std::string m_extra;

470

  std::string m_extra; //!< extra parameters for the plot

450

471

451

  bool m_generateOneOutputFile;

472

  bool m_generateOneOutputFile; //!< true if only one plot will be generated

452

473

453

  unsigned int m_dataFileDatasetIndex;

474

  unsigned int m_dataFileDatasetIndex; //!< Data set index to plot

454

};

475

};

455

476

456

/**

477

/**

478

 * \ingroup gnuplot

479

457

 * \brief a simple class to group together multiple gnuplots into one file,

480

 * \brief a simple class to group together multiple gnuplots into one file,

458

 * e.g. for PDF multi-page output terminals.

481

 * e.g. for PDF multi-page output terminals.

459

*/

482

*/

Lines 505-516	Link Here

505

                       std::string dataFileName);

528

                       std::string dataFileName);

506

529

507

private:

530

private:

531

  /// Type of the Gnuplot collection

508

  typedef std::vector<Gnuplot> Plots;

532

  typedef std::vector<Gnuplot> Plots;

509

533

510

  std::string m_outputFilename;

534

  std::string m_outputFilename; //!< Output file name

511

  std::string m_terminal;

535

  std::string m_terminal; //!< Gnuplot "terminal" to use

512

536

513

  Plots       m_plots;

537

  Plots       m_plots; //!< Plots in the collection

514

};

538

};

515

539

516

} // namespace ns3

540

} // namespace ns3

(-)a/src/stats/model/omnet-data-output.h (-2 / +47 lines)

Lines 31-37	Link Here

//------------------------------------------------------------

//------------------------------------------------------------

//--------------------------------------------

//--------------------------------------------

/**

/**

 * \ingroup stats

 * \ingroup dataoutput

 * \class OmnetDataOutput

 * \class OmnetDataOutput

 * \brief Outputs data in a format compatible with OMNeT library and framework

 * \brief Outputs data in a format compatible with OMNeT library and framework

Lines 47-82	Link Here

  virtual void DoDispose ();

  virtual void DoDispose ();

private:

private:

/**

   * \ingroup dataoutput

   * \brief Class to generate OMNeT output

*/

  class OmnetOutputCallback : public DataOutputCallback {

  class OmnetOutputCallback : public DataOutputCallback {

public:

public:

/**

     * Constructor

     * \param scalar the output stream

*/

    OmnetOutputCallback(std::ostream *scalar);

    OmnetOutputCallback(std::ostream *scalar);

/**

     * \brief Generates data statistics

     * \param context the output context

     * \param name the output name

     * \param statSum the stats to print

*/

    void OutputStatistic (std::string context,

    void OutputStatistic (std::string context,

                          std::string name,

                          std::string name,

                          const StatisticalSummary *statSum);

                          const StatisticalSummary *statSum);

/**

     * \brief Generates a single data output

     * \param context the output context

     * \param name the output name

     * \param val the value

*/

    void OutputSingleton (std::string context,

    void OutputSingleton (std::string context,

                          std::string name,

                          std::string name,

                          int val);

                          int val);

/**

     * \brief Generates a single data output

     * \param context the output context

     * \param name the output name

     * \param val the value

*/

    void OutputSingleton (std::string context,

    void OutputSingleton (std::string context,

                          std::string name,

                          std::string name,

                          uint32_t val);

                          uint32_t val);

/**

     * \brief Generates a single data output

     * \param context the output context

     * \param name the output name

     * \param val the value

*/

    void OutputSingleton (std::string context,

    void OutputSingleton (std::string context,

                          std::string name,

100

                          std::string name,

                          double val);

101

                          double val);

102

103

/**

104

     * \brief Generates a single data output

105

     * \param context the output context

106

     * \param name the output name

107

     * \param val the value

108

*/

    void OutputSingleton (std::string context,

109

    void OutputSingleton (std::string context,

                          std::string name,

110

                          std::string name,

                          std::string val);

111

                          std::string val);

112

113

/**

114

     * \brief Generates a single data output

115

     * \param context the output context

116

     * \param name the output name

117

     * \param val the value

118

*/

    void OutputSingleton (std::string context,

119

    void OutputSingleton (std::string context,

                          std::string name,

120

                          std::string name,

                          Time val);

121

                          Time val);

122

private:

123

private:

    std::ostream *m_scalar;

124

    std::ostream *m_scalar; //!< output stream

    // end class OmnetOutputCallback

125

    // end class OmnetOutputCallback

};

126

};

127

(-)a/src/stats/model/probe.h (+6 lines)

Lines 28-33	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup probes

 * Base class for probes.

 * Base class for probes.

 * This class provides general functionality to control each

 * This class provides general functionality to control each

Lines 37-42	Link Here

class Probe : public DataCollectionObject

class Probe : public DataCollectionObject

public:

public:

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId ();

  static TypeId GetTypeId ();

  Probe ();

  Probe ();

  virtual ~Probe ();

  virtual ~Probe ();

(-)a/src/stats/model/sqlite-data-output.h (-4 / +56 lines)

Lines 34-40	Link Here

//------------------------------------------------------------

//------------------------------------------------------------

//--------------------------------------------

//--------------------------------------------

/**

/**

 * \ingroup stats

 * \ingroup dataoutput

 * \class SqliteDataOutput

 * \class SqliteDataOutput

 * \brief Outputs data in a format compatible with SQLite

 * \brief Outputs data in a format compatible with SQLite

*/

*/

Lines 49-91	Link Here

  virtual void DoDispose ();

  virtual void DoDispose ();

private:

private:

/**

   * \ingroup dataoutput

   * \brief Class to generate OMNeT output

*/

  class SqliteOutputCallback : public DataOutputCallback {

  class SqliteOutputCallback : public DataOutputCallback {

public:

public:

/**

     * Constructor

     * \param owner pointer to the instance this object belongs to

     * \param run experiment descriptor

*/

    SqliteOutputCallback(Ptr<SqliteDataOutput> owner, std::string run);

    SqliteOutputCallback(Ptr<SqliteDataOutput> owner, std::string run);

/**

     * \brief Generates data statistics

     * \param key the SQL key to use

     * \param variable the variable name

     * \param statSum the stats to print

*/

    void OutputStatistic (std::string key,

    void OutputStatistic (std::string key,

                          std::string variable,

                          std::string variable,

                          const StatisticalSummary *statSum);

                          const StatisticalSummary *statSum);

/**

     * \brief Generates a single data output

     * \param key the SQL key to use

     * \param variable the variable name

     * \param val the value

*/

    void OutputSingleton (std::string key,

    void OutputSingleton (std::string key,

                          std::string variable,

                          std::string variable,

                          int val);

                          int val);

/**

     * \brief Generates a single data output

     * \param key the SQL key to use

     * \param variable the variable name

     * \param val the value

*/

    void OutputSingleton (std::string key,

    void OutputSingleton (std::string key,

                          std::string variable,

                          std::string variable,

                          uint32_t val);

                          uint32_t val);

/**

     * \brief Generates a single data output

     * \param key the SQL key to use

     * \param variable the variable name

100

     * \param val the value

101

*/

    void OutputSingleton (std::string key,

102

    void OutputSingleton (std::string key,

                          std::string variable,

103

                          std::string variable,

                          double val);

104

                          double val);

105

106

/**

107

     * \brief Generates a single data output

108

     * \param key the SQL key to use

109

     * \param variable the variable name

110

     * \param val the value

111

*/

    void OutputSingleton (std::string key,

112

    void OutputSingleton (std::string key,

                          std::string variable,

113

                          std::string variable,

                          std::string val);

114

                          std::string val);

115

116

/**

117

     * \brief Generates a single data output

118

     * \param key the SQL key to use

119

     * \param variable the variable name

120

     * \param val the value

121

*/

    void OutputSingleton (std::string key,

122

    void OutputSingleton (std::string key,

                          std::string variable,

123

                          std::string variable,

                          Time val);

124

                          Time val);

125

private:

126

private:

    Ptr<SqliteDataOutput> m_owner;

127

    Ptr<SqliteDataOutput> m_owner; //!< the instance this object belongs to

    std::string m_runLabel;

128

    std::string m_runLabel; //!< Run label

129

    // end class SqliteOutputCallback

130

    // end class SqliteOutputCallback

};

131

};

132

133

  sqlite3 *m_db;

134

  sqlite3 *m_db; //!< pointer to the SQL database

135

136

/**

137

   * \brief Execute a sqlite3 query

138

   * \param exe the query to execute

139

   * \return sqlite return code.

140

*/

  int Exec (std::string exe);

141

  int Exec (std::string exe);

142

  // end class SqliteDataOutput

143

  // end class SqliteDataOutput




/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2013 Universita' di Firenze
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Author: Tommaso Pecorella <tommaso.pecorella@unifi.it>
 */

#ifndef STATS_H
#define STATS_H

// Header file used only to define the stats group in Doxygen

/**
 * \defgroup stats Statistics
 *
 * The statistics module includes some useful features to ease data collection from experiments.
 * In particular the following features are included:
 * <ul>
 * <li> The core framework and two basic data collectors: A counter, and a min/max/avg/total observer.</li>
 * <li> Extensions of those to easily work with times and packets.</li>
 * <li> Plaintext output formatted for OMNet++.</li>
 * <li> Database output using SQLite, a standalone, lightweight, high performance SQL engine.</li>
 * <li> Mandatory and open ended metadata for describing and working with runs.</li>
 * </ul>
 *
 * See the manual for a complete documentation.
 */

/**
 * \ingroup stats
 * \defgroup aggregator Data Aggregators
 *
 * Data aggregators are classes used to collect data and produce output
 * specialized for various purpose, e.g., Gnuplot, file output, etc.
 */

/**
 * \ingroup stats
 * \defgroup probes Probes
 *
 * Probes are used to probe an underlying ns3 TraceSource exporting
 * its value.  This probe usually exports a trace source "Output".
 * The Output trace source emits a value when either the trace source
 * emits a new value, or when SetValue () is called.
 *
 * Probes are a special kind of Data Aggregator
 */

/**
 * \ingroup stats
 * \defgroup gnuplot Gnuplot
 *
 * Classes in Gnuplot group are used to collect and prepare and output data
 * for subsequent processing by Gnuplot.
 */

/**
 * \ingroup stats
 * \defgroup dataoutput Data Output
 *
 * Classes in Data Output group are used to collect and prepare and output data
 * for subsequent ouput in a specific format, e.g., Omnet++, SQLite, etc.
 */

#endif /* STATS_H */

(-)a/src/stats/model/time-data-calculators.h (-4 / +4 lines)

Lines 59-68	Link Here

protected:

protected:

  virtual void DoDispose (void);

  virtual void DoDispose (void);

  uint32_t m_count; /// Count value of TimeMinMaxAvgTotalCalculator

  uint32_t m_count; //!< Count value of TimeMinMaxAvgTotalCalculator

  Time m_total;     /// Total value of TimeMinMaxAvgTotalCalculator

  Time m_total;     //!< Total value of TimeMinMaxAvgTotalCalculator

  Time m_min;       /// Minimum value of TimeMinMaxAvgTotalCalculator

  Time m_min;       //!< Minimum value of TimeMinMaxAvgTotalCalculator

  Time m_max;       /// Maximum value of TimeMinMaxAvgTotalCalculator

  Time m_max;       //!< Maximum value of TimeMinMaxAvgTotalCalculator

  // end class TimeMinMaxAvgTotalCalculator

  // end class TimeMinMaxAvgTotalCalculator

};

};

(-)a/src/stats/model/time-series-adaptor.h (-1 / +7 lines)

Lines 29-34	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup aggregator

 * \brief Takes probed values of different types and outputs the

 * \brief Takes probed values of different types and outputs the

 * current time plus the value with both converted to doubles.

 * current time plus the value with both converted to doubles.

Lines 46-51	Link Here

class TimeSeriesAdaptor : public DataCollectionObject

class TimeSeriesAdaptor : public DataCollectionObject

public:

public:

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId (void);

  static TypeId GetTypeId (void);

  TimeSeriesAdaptor ();

  TimeSeriesAdaptor ();

Lines 107-113	Link Here

107

  void TraceSinkUinteger32 (uint32_t oldData, uint32_t newData);

113

  void TraceSinkUinteger32 (uint32_t oldData, uint32_t newData);

108

114

109

private:

115

private:

110

  TracedCallback<double, double> m_output;

116

  TracedCallback<double, double> m_output; //!< output trace

111

};

117

};

112

118

113

} // namespace ns3

119

} // namespace ns3

(-)a/src/stats/model/uinteger-16-probe.h (-3 / +7 lines)

Lines 31-36	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup probes

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * an uint16_t.  This probe exports a trace source "Output" of type uint16_t.

 * an uint16_t.  This probe exports a trace source "Output" of type uint16_t.

 * The Output trace source emits a value when either the trace source

 * The Output trace source emits a value when either the trace source

Lines 41-46	Link Here

class Uinteger16Probe : public Probe

class Uinteger16Probe : public Probe

public:

public:

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId ();

  static TypeId GetTypeId ();

  Uinteger16Probe ();

  Uinteger16Probe ();

  virtual ~Uinteger16Probe ();

  virtual ~Uinteger16Probe ();

Lines 88-99	Link Here

   * \param oldData previous value of the uint16_t

   * \param oldData previous value of the uint16_t

   * \param newData new value of the uint16_t

   * \param newData new value of the uint16_t

   * \internal

*/

*/

  void TraceSink (uint16_t oldData, uint16_t newData);

  void TraceSink (uint16_t oldData, uint16_t newData);

  TracedValue<uint16_t> m_output;

100

  TracedValue<uint16_t> m_output; //!< Output trace source.

};

101

};

102

} // namespace ns3

103

} // namespace ns3

(-)a/src/stats/model/uinteger-32-probe.h (-3 / +7 lines)

Lines 31-36	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup probes

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * an uint32_t.  This probe exports a trace source "Output" of type uint32_t.

 * an uint32_t.  This probe exports a trace source "Output" of type uint32_t.

 * The Output trace source emits a value when either the trace source

 * The Output trace source emits a value when either the trace source

Lines 41-46	Link Here

class Uinteger32Probe : public Probe

class Uinteger32Probe : public Probe

public:

public:

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId ();

  static TypeId GetTypeId ();

  Uinteger32Probe ();

  Uinteger32Probe ();

  virtual ~Uinteger32Probe ();

  virtual ~Uinteger32Probe ();

Lines 88-99	Link Here

   * \param oldData previous value of the uint32_t

   * \param oldData previous value of the uint32_t

   * \param newData new value of the uint32_t

   * \param newData new value of the uint32_t

   * \internal

*/

*/

  void TraceSink (uint32_t oldData, uint32_t newData);

  void TraceSink (uint32_t oldData, uint32_t newData);

  TracedValue<uint32_t> m_output;

100

  TracedValue<uint32_t> m_output; //!< Output trace source.

};

101

};

102

} // namespace ns3

103

} // namespace ns3

(-)a/src/stats/model/uinteger-8-probe.h (-3 / +7 lines)

Lines 31-36	Link Here

namespace ns3 {

namespace ns3 {

/**

/**

 * \ingroup probes

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * This class is designed to probe an underlying ns3 TraceSource exporting

 * an uint8_t.  This probe exports a trace source "Output" of type uint8_t.

 * an uint8_t.  This probe exports a trace source "Output" of type uint8_t.

 * The Output trace source emits a value when either the trace source

 * The Output trace source emits a value when either the trace source

Lines 41-46	Link Here

class Uinteger8Probe : public Probe

class Uinteger8Probe : public Probe

public:

public:

/**

   * \brief Get the type ID.

   * \return the object TypeId

*/

  static TypeId GetTypeId ();

  static TypeId GetTypeId ();

  Uinteger8Probe ();

  Uinteger8Probe ();

  virtual ~Uinteger8Probe ();

  virtual ~Uinteger8Probe ();

Lines 88-99	Link Here

   * \param oldData previous value of the uint8_t

   * \param oldData previous value of the uint8_t

   * \param newData new value of the uint8_t

   * \param newData new value of the uint8_t

   * \internal

*/

*/

  void TraceSink (uint8_t oldData, uint8_t newData);

  void TraceSink (uint8_t oldData, uint8_t newData);

  TracedValue<uint8_t> m_output;

100

  TracedValue<uint8_t> m_output; //!< Output trace source.

};

101

};

102

} // namespace ns3

103

} // namespace ns3

Return to bug 938