Attachment #1887 for bug #1997

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





::

  +  std::string probeType;
  +  std::string tracePath;
  +  if (useV6 == false)
  +    {
     ...
  +      probeType = "ns3::Ipv4PacketProbe";
  +      tracePath = "/NodeList/*/$ns3::Ipv4L3Protocol/Tx";
  +    }
  +  else
  +    {
     ...
  +      probeType = "ns3::Ipv6PacketProbe";
  +      tracePath = "/NodeList/*/$ns3::Ipv6L3Protocol/Tx";
  +    }
   ...
  +   // Use GnuplotHelper to plot the packet byte count over time

  +                             "Time (Seconds)",
  +                             "Packet Byte Count");
  + 
  +   // Specify the probe type, trace source path (in configuration namespace), and
  +   // probe output trace source ("OutputBytes") to plot.  The fourth argument
  +   // specifies the name of the data series label on the plot.  The last
  +   // argument formats the plot by specifying where the key should be placed.
  +   plotHelper.PlotProbe (probeType,
  +                         tracePath,
  +                         "OutputBytes",
  +                         "Packet Byte Count",
  +                         GnuplotAggregator::KEY_BELOW);

  + 
  +   // Specify the probe type, probe path (in configuration namespace), and
  +   // probe output trace source ("OutputBytes") to write.
  +   fileHelper.WriteProbe (probeType,
  +                          tracePath,
  +                          "OutputBytes");
  + 
      Simulator::Stop (Seconds (20));

  

The careful reader will have noticed, when testing the IPv6 command
line attribute above, that ``seventh.cc`` had created a number of new output files:

::



::

  +  std::string probeType;
  +  std::string tracePath;
  +  probeType = "ns3::Ipv6PacketProbe";
  +  tracePath = "/NodeList/*/$ns3::Ipv6L3Protocol/Tx";

We use them here:

::
   
  +  // Specify the probe type, trace source path (in configuration namespace), and
  +  // probe output trace source ("OutputBytes") to plot.  The fourth argument
  +  // specifies the name of the data series label on the plot.  The last
  +  // argument formats the plot by specifying where the key should be placed.
  +  plotHelper.PlotProbe (probeType,
  +                        tracePath,
  +                        "OutputBytes",
  +                        "Packet Byte Count",
  +                        GnuplotAggregator::KEY_BELOW);

The first two arguments are the name of the probe type and the trace source path.
These two are probably the hardest to determine when you try to use
this framework to plot other traces.  The probe trace here is the ``Tx``
trace source of class ``Ipv6L3Protocol``.  When we examine this class

  +   // Set the labels for this formatted output file.
  +   fileHelper.Set2dFormat ("Time (Seconds) = %.3e\tPacket Byte Count = %.0f");

Finally, the trace source of interest must be hooked.  Again, the probeType and
tracePath variables in this example are used, and the probe's output
trace source "OutputBytes" is hooked:

::

  + 
  +   // Specify the probe type, trace source path (in configuration namespace), and
  +   // probe output trace source ("OutputBytes") to write.
  +   fileHelper.WriteProbe (probeType,
  +                          tracePath,
  +                          "OutputBytes");
  + 





  uint16_t sinkPort = 8080;
  Address sinkAddress;
  Address anyAddress;
  std::string probeType;
  std::string tracePath;
  if (useV6 == false)
    {
      Ipv4AddressHelper address;

      Ipv4InterfaceContainer interfaces = address.Assign (devices);
      sinkAddress = InetSocketAddress (interfaces.GetAddress (1), sinkPort);
      anyAddress = InetSocketAddress (Ipv4Address::GetAny (), sinkPort);
      probeType = "ns3::Ipv4PacketProbe";
      tracePath = "/NodeList/*/$ns3::Ipv4L3Protocol/Tx";
    }
  else
    {

      Ipv6InterfaceContainer interfaces = address.Assign (devices);
      sinkAddress = Inet6SocketAddress (interfaces.GetAddress (1,1), sinkPort);
      anyAddress = Inet6SocketAddress (Ipv6Address::GetAny (), sinkPort);
      probeType = "ns3::Ipv6PacketProbe";
      tracePath = "/NodeList/*/$ns3::Ipv6L3Protocol/Tx";
    }

  PacketSinkHelper packetSinkHelper ("ns3::TcpSocketFactory", anyAddress);

                            "Time (Seconds)",
                            "Packet Byte Count");

  // Specify the probe type, trace source path (in configuration namespace), and
  // probe output trace source ("OutputBytes") to plot.  The fourth argument
  // specifies the name of the data series label on the plot.  The last
  // argument formats the plot by specifying where the key should be placed.
  plotHelper.PlotProbe (probeType,
                        tracePath,
                        "OutputBytes",
                        "Packet Byte Count",
                        GnuplotAggregator::KEY_BELOW);

  // Set the labels for this formatted output file.
  fileHelper.Set2dFormat ("Time (Seconds) = %.3e\tPacket Byte Count = %.0f");

  // Specify the probe type, trace source path (in configuration namespace), and
  // probe output trace source ("OutputBytes") to write.
  fileHelper.WriteProbe (probeType,
                         tracePath,
                         "OutputBytes");

  Simulator::Stop (Seconds (20));

(-)a/src/stats/doc/data-collection-helpers.rst (-72 / +58 lines)

Lines 75-81	Link Here

                       const std::string &yLegend,

                       const std::string &yLegend,

                       const std::string &terminalType = ".png");

                       const std::string &terminalType = ".png");

The second statement hooks the ``Probe`` of interest:

The second statement hooks the trace source of interest:

::

::

Lines 87-95	Link Here

The arguments are as follows:

The arguments are as follows:

* typeId:  The |ns3| TypeId of the Probe

* typeId:  The |ns3| TypeId of the Probe

* path:  The path in the |ns3| configuration namespace to one or more probes

* path:  The path in the |ns3| configuration namespace to one or more trace sources

* probeTraceSource:  Which output of the probe should be connected to

* probeTraceSource:  Which output of the probe (itself a trace source) should be plotted

* title:  The title to associate with the dataset (in the gnuplot legend)

* title:  The title to associate with the dataset(s) (in the gnuplot legend)

A variant on the PlotProbe above is to specify a fifth optional argument

A variant on the PlotProbe above is to specify a fifth optional argument

that controls where in the plot the key (legend) is placed.

that controls where in the plot the key (legend) is placed.

Lines 102-121	Link Here

102

   GnuplotHelper plotHelper;

102

   GnuplotHelper plotHelper;

103

104

   // Configure the plot.

104

   // Configure the plot.

105

   // Configure the plot.  The first argument is the file name prefix

106

   // for the output files generated.  The second, third, and fourth

107

   // arguments are, respectively, the plot title, x-axis, and y-axis labels

105

   plotHelper.ConfigurePlot ("seventh-packet-byte-count",

108

   plotHelper.ConfigurePlot ("seventh-packet-byte-count",

106

                             "Packet Byte Count vs. Time",

109

                             "Packet Byte Count vs. Time",

107

                             "Time (Seconds)",

110

                             "Time (Seconds)",

108

                             "Packet Byte Count",

111

                             "Packet Byte Count",

109

                             "png");

112

                             "png");

110

113

111

   // Plot the values generated by the probe.

114

   // Specify the probe type, trace source path (in configuration namespace), and

112

   plotHelper.PlotProbe ("ns3::Ipv4PacketProbe",

115

   // probe output trace source ("OutputBytes") to plot.  The fourth argument

113

                         "/NodeList/*/$ns3::Ipv4L3Protocol/Tx",

116

   // specifies the name of the data series label on the plot.  The last

117

   // argument formats the plot by specifying where the key should be placed.

118

   plotHelper.PlotProbe (probeType,

119

                         tracePath,

114

                         "OutputBytes",

120

                         "OutputBytes",

115

                         "Packet Byte Count",

121

                         "Packet Byte Count",

116

                         GnuplotAggregator::KEY_BELOW);

122

                         GnuplotAggregator::KEY_BELOW);

117

123

118

Note that the path specified may contain wildcards.  In this case, multiple

124

In this example, the ``probeType`` and ``tracePath`` are as follows (for IPv4):

125

126

::

127

128

   probeType = "ns3::Ipv4PacketProbe";

129

   tracePath = "/NodeList/*/$ns3::Ipv4L3Protocol/Tx";

130

131

The probeType is a key parameter for this helper to work.  This TypeId

132

must be registered in the system, and the signature on the Probe's trace

133

sink must match that of the trace source it is being hooked to.  Probe

134

types are pre-defined for a number of data types corresponding to |ns3|

135

traced values, and for a few other trace source signatures such as the

136

'Tx' trace source of ``ns3::Ipv4L3Protocol`` class.

137

138

Note that the trace source path specified may contain wildcards.

139

In this case, multiple

119

datasets are plotted on one plot; one for each matched path.

140

datasets are plotted on one plot; one for each matched path.

120

141

121

The main output produced will be three files:

142

The main output produced will be three files:

Lines 224-233	Link Here

224

  | Argument         | Description                  |

245

  | Argument         | Description                  |

225

  +==================+==============================+

246

  +==================+==============================+

226

  | typeId           | The type ID for the probe    |

247

  | typeId           | The type ID for the probe    |

227

  |                  | used when it is created.     |

248

  |                  | created by this helper.      |

228

  +------------------+------------------------------+

249

  +------------------+------------------------------+

229

  | path             | Config path to access the    |

250

  | path             | Config path to access the    |

230

  |                  | probe.                       |

251

  |                  | trace source.                |

231

  +------------------+------------------------------+

252

  +------------------+------------------------------+

232

  | probeTraceSource | The probe trace source to    |

253

  | probeTraceSource | The probe trace source to    |

233

  |                  | access.                      |

254

  |                  | access.                      |

Lines 242-248	Link Here

242

263

243

The GnuplotHelper's ``PlotProbe()`` function

264

The GnuplotHelper's ``PlotProbe()`` function

244

plots a dataset generated by hooking the |ns3| trace source with a

265

plots a dataset generated by hooking the |ns3| trace source with a

245

probe, and then plotting the values from the probeTraceSource.

266

probe created by the helper, and then plotting the values from the

267

probeTraceSource.

246

The dataset will have the provided title, and will consist of

268

The dataset will have the provided title, and will consist of

247

the 'newValue' at each timestamp.

269

the 'newValue' at each timestamp.

248

270

Lines 256-262	Link Here

256

possible as labels for the datasets that are plotted.

278

possible as labels for the datasets that are plotted.

257

279

258

An example of how to use this function can be seen in the

280

An example of how to use this function can be seen in the

259

``seventh.cc`` code described above where it was used as follows:

281

``seventh.cc`` code described above where it was used (with

282

variable substitution) as follows:

260

283

261

::

284

::

262

285

Lines 273-283	Link Here

273

~~~~~~~~~~~~~~~~~~~~~~

296

~~~~~~~~~~~~~~~~~~~~~~

274

297

275

A slightly simpler example than the ``seventh.cc`` example can be

298

A slightly simpler example than the ``seventh.cc`` example can be

276

found in ``src/stats/examples/gnuplot-helper-example.cc``.  It

299

found in ``src/stats/examples/gnuplot-helper-example.cc``.  The

277

is more of a toy example than ``seventh.cc`` because it has

300

following 2-D gnuplot was created using the example.

278

a made-up trace source created for demonstration purposes.

279

280

The following 2-D gnuplot was created using the example.

281

301

282

.. _gnuplot-helper-example:

302

.. _gnuplot-helper-example:

283

303

Lines 286-292	Link Here

286

  2-D Gnuplot Created by gnuplot-helper-example.cc Example.

306

  2-D Gnuplot Created by gnuplot-helper-example.cc Example.

287

307

288

In this example, there is an Emitter object that increments

308

In this example, there is an Emitter object that increments

289

its counter at various random times and then emits the counter's

309

its counter according to a Poisson process and then emits the counter's

290

value as a trace source.

310

value as a trace source.

291

311

292

::

312

::

Lines 294-318	Link Here

294

  Ptr<Emitter> emitter = CreateObject<Emitter> ();

314

  Ptr<Emitter> emitter = CreateObject<Emitter> ();

295

  Names::Add ("/Names/Emitter", emitter);

315

  Names::Add ("/Names/Emitter", emitter);

296

316

297

The following code is probing the Counter exported by the

298

emitter object.  This DoubleProbe is using a path in the

299

configuration namespace to make the connection.  Note that

300

the emitter registered itself in the configuration namespace

301

after it was created; otherwise, the ConnectByPath would not work.

302

303

::

304

305

  Ptr<DoubleProbe> probe = CreateObject<DoubleProbe> ();

306

  probe->SetName ("PathProbe");

307

  Names::Add ("/Names/Probe", probe);

308

309

  // Note, no return value is checked here.

310

  probe->ConnectByPath ("/Names/Emitter/Counter");

311

312

Note that because there are no wildcards in the path

317

Note that because there are no wildcards in the path

313

used below, only 1 datastream was drawn in the plot.

318

used below, only 1 datastream was drawn in the plot.

314

This single datastream in the plot is simply labeled

319

This single datastream in the plot is simply labeled

315

"Emitter Count", with no extra suffixes like you would

320

"Emitter Count", with no extra suffixes like one would

316

see if there were wildcards in the path.

321

see if there were wildcards in the path.

317

322

318

::

323

::

Lines 329-336	Link Here

329

334

330

  // Plot the values generated by the probe.  The path that we provide

335

  // Plot the values generated by the probe.  The path that we provide

331

  // helps to disambiguate the source of the trace.

336

  // helps to disambiguate the source of the trace.

332

  plotHelper.PlotProbe ("ns3::DoubleProbe",

337

  plotHelper.PlotProbe ("ns3::Uinteger32Probe",

333

                        "/Names/Probe/Output",

338

                        "/Names/Emitter/Counter",

334

                        "Output",

339

                        "Output",

335

                        "Emitter Count",

340

                        "Emitter Count",

336

                        GnuplotAggregator::KEY_INSIDE);

341

                        GnuplotAggregator::KEY_INSIDE);

Lines 492-501	Link Here

492

  | Argument         | Description                  |

497

  | Argument         | Description                  |

493

  +==================+==============================+

498

  +==================+==============================+

494

  | typeId           | The type ID for the probe    |

499

  | typeId           | The type ID for the probe    |

495

  |                  | used when it is created.     |

500

  |                  | to be created.               |

496

  +------------------+------------------------------+

501

  +------------------+------------------------------+

497

  | path             | Config path to access the    |

502

  | path             | Config path to access the    |

498

  |                  | probe.                       |

503

  |                  | trace source.                |

499

  +------------------+------------------------------+

504

  +------------------+------------------------------+

500

  | probeTraceSource | The probe trace source to    |

505

  | probeTraceSource | The probe trace source to    |

501

  |                  | access.                      |

506

  |                  | access.                      |

Lines 503-509	Link Here

503

508

504

The FileHelper's ``WriteProbe()`` function

509

The FileHelper's ``WriteProbe()`` function

505

creates output text files generated by hooking the ns-3 trace source

510

creates output text files generated by hooking the ns-3 trace source

506

with a probe, and then writing the values from the

511

with a probe created by the helper, and then writing the values from the

507

probeTraceSource. The output file names will have the text stored

512

probeTraceSource. The output file names will have the text stored

508

in the member variable  m_outputFileNameWithoutExtension plus ".txt",

513

in the member variable  m_outputFileNameWithoutExtension plus ".txt",

509

and will consist of the 'newValue' at each timestamp.

514

and will consist of the 'newValue' at each timestamp.

Lines 537-545	Link Here

537

542

538

A slightly simpler example than the ``seventh.cc`` example can be

543

A slightly simpler example than the ``seventh.cc`` example can be

539

found in ``src/stats/examples/file-helper-example.cc``.

544

found in ``src/stats/examples/file-helper-example.cc``.

540

This example only uses the FileHelper, not the FileHelper.  It

545

This example only uses the FileHelper.

541

is also more of a toy example than ``seventh.cc`` because it has

542

a made-up trace source created for demonstration purposes.

543

546

544

The following text file with 2 columns of formatted values named

547

The following text file with 2 columns of formatted values named

545

``file-helper-example.txt`` was created using the example.

548

``file-helper-example.txt`` was created using the example.

Lines 547-567	Link Here

547

550

548

.. sourcecode:: text

551

.. sourcecode:: text

549

552

550

  Time (Seconds) = 4.995e-01	Count = 1

553

  Time (Seconds) = 0.203  Count = 1

551

  Time (Seconds) = 1.463e+00	Count = 2

554

  Time (Seconds) = 0.702  Count = 2

552

  Time (Seconds) = 1.678e+00	Count = 3

555

  Time (Seconds) = 1.404  Count = 3

553

  Time (Seconds) = 3.972e+00	Count = 4

556

  Time (Seconds) = 2.368  Count = 4

554

  Time (Seconds) = 4.150e+00	Count = 5

557

  Time (Seconds) = 3.364  Count = 5

555

  Time (Seconds) = 8.066e+00	Count = 6

558

  Time (Seconds) = 3.579  Count = 6

556

  Time (Seconds) = 8.731e+00	Count = 7

559

  Time (Seconds) = 5.873  Count = 7

557

  Time (Seconds) = 9.807e+00	Count = 8

560

  Time (Seconds) = 6.410  Count = 8

558

  Time (Seconds) = 1.078e+01	Count = 9

561

  Time (Seconds) = 6.472  Count = 9

559

  Time (Seconds) = 1.083e+01	Count = 10

560

561

...

562

...

562

563

In this example, there is an Emitter object that increments

564

In this example, there is an Emitter object that increments

564

its counter at various random times and then emits the counter's

565

its counter according to a Poisson process and then emits the counter's

565

value as a trace source.

566

value as a trace source.

566

567

::

568

::

Lines 569-589	Link Here

569

  Ptr<Emitter> emitter = CreateObject<Emitter> ();

570

  Ptr<Emitter> emitter = CreateObject<Emitter> ();

570

  Names::Add ("/Names/Emitter", emitter);

571

  Names::Add ("/Names/Emitter", emitter);

571

572

The following code is probing the Counter exported by the

573

emitter object.  This DoubleProbe is using a path in the

574

configuration namespace to make the connection.  Note that

575

the emitter registered itself in the configuration namespace

576

after it was created; otherwise, the ConnectByPath would not work.

577

578

::

579

580

  Ptr<DoubleProbe> probe = CreateObject<DoubleProbe> ();

581

  probe->SetName ("PathProbe");

582

  Names::Add ("/Names/Probe", probe);

583

584

  // Note, no return value is checked here.

585

  probe->ConnectByPath ("/Names/Emitter/Counter");

586

587

Note that because there are no wildcards in the path

573

Note that because there are no wildcards in the path

588

used below, only 1 text file was created.

574

used below, only 1 text file was created.

589

This single text file is simply named

575

This single text file is simply named

Lines 604-611	Link Here

604

590

605

  // Write the values generated by the probe.  The path that we

591

  // Write the values generated by the probe.  The path that we

606

  // provide helps to disambiguate the source of the trace.

592

  // provide helps to disambiguate the source of the trace.

607

  fileHelper.WriteProbe ("ns3::DoubleProbe",

593

  fileHelper.WriteProbe ("ns3::Uinteger32Probe",

608

                         "/Names/Probe/Output",

594

                         "/Names/Emitter/Counter",

609

                         "Output");

595

                         "Output");

610

596

611

Scope and Limitations

597

Scope and Limitations

Lines 623-629	Link Here

623

- ApplicationPacketProbe

609

- ApplicationPacketProbe

624

- Ipv4PacketProbe

610

- Ipv4PacketProbe

625

611

626

These Probes, therefore, are the only ones available to be used

612

These Probes, therefore, are the only TypeIds available to be used

627

in ``PlotProbe()`` and ``WriteProbe()``.

613

in ``PlotProbe()`` and ``WriteProbe()``.

628

614

629

In the next few sections, we cover each of the fundamental object

615

In the next few sections, we cover each of the fundamental object





NS_LOG_COMPONENT_DEFINE ("FileHelperExample");

//
// This is our test object, an object that increments a counter according
// to a Poisson process, and exports the (integer-valued) count as a
// trace source.
//
class Emitter : public Object
{
public:

  Emitter ();
private:
  void DoInitialize (void);
  void Emit (void);
  void Count (void);

  TracedValue<uint32_t> m_counter;
  Ptr<ExponentialRandomVariable> m_var;

};

Emitter::DoInitialize (void)
{
  NS_LOG_FUNCTION (this);
  Simulator::Schedule (Seconds (m_var->GetValue ()), &Emitter::Emit, this);
  Simulator::Schedule (Seconds (m_var->GetValue ()), &Emitter::Count, this);
}

void
Emitter::Emit (void)
{
  NS_LOG_FUNCTION (this);
  NS_LOG_DEBUG ("Emitting at " << Simulator::Now ().GetSeconds ());
  Simulator::Schedule (Seconds (m_var->GetValue ()), &Emitter::Emit, this);
}

void
Emitter::Count (void)
{
  NS_LOG_FUNCTION (this);

  Names::Add ("/Names/Emitter", emitter);

  //
  // This Probe will be hooked to the Emitter's trace source object by
  // accessing it by path name in the Config database.
  //

  Ptr<DoubleProbe> probe = CreateObject<DoubleProbe> ();
  probe->SetName ("PathProbe");
  Names::Add ("/Names/Probe", probe);

  // Note, no return value is checked here.
  probe->ConnectByPath ("/Names/Emitter/Counter");

  //
  // This file helper will be used to put data values into a file.
  //


                            FileAggregator::FORMATTED);

  // Set the labels for this formatted output file.
  fileHelper.Set2dFormat ("Time (Seconds) = %.3f\tCount = %.0f");

  // Write the values generated by the probe.  The path that we
  // provide helps to disambiguate the source of the trace.
  fileHelper.WriteProbe ("ns3::Uinteger32Probe",
                         "/Names/Emitter/Counter",
                         "Output");

  // The Emitter object is not associated with an ns-3 node, so





NS_LOG_COMPONENT_DEFINE ("GnuplotHelperExample");

//
// This is our test object, an object that increments a counter according
// to a Poisson process, and exports the (integer-valued) count as a
// trace source.
//
class Emitter : public Object
{
public:

  Emitter ();
private:
  void DoInitialize (void);
  void Emit (void);
  void Count (void);

  TracedValue<uint32_t> m_counter;
  Ptr<ExponentialRandomVariable> m_var;

};

NS_OBJECT_ENSURE_REGISTERED (Emitter);

Emitter::DoInitialize (void)
{
  NS_LOG_FUNCTION (this);
  Simulator::Schedule (Seconds (m_var->GetValue ()), &Emitter::Emit, this);
  Simulator::Schedule (Seconds (m_var->GetValue ()), &Emitter::Count, this);
}

void
Emitter::Emit (void)
{
  NS_LOG_FUNCTION (this);
  NS_LOG_DEBUG ("Emitting at " << Simulator::Now ().GetSeconds ());
  Simulator::Schedule (Seconds (m_var->GetValue ()), &Emitter::Emit, this);
}

void
Emitter::Count (void)
{
  NS_LOG_FUNCTION (this);

  Names::Add ("/Names/Emitter", emitter);

  //
  // This Probe will be hooked to the Emitter's trace source object by
  // accessing it by path name in the Config database.
  //

  Ptr<DoubleProbe> probe = CreateObject<DoubleProbe> ();
  probe->SetName ("PathProbe");
  Names::Add ("/Names/Probe", probe);

  // Note, no return value is checked here.
  probe->ConnectByPath ("/Names/Emitter/Counter");

  //
  // This gnuplot helper will be used to produce output used to make
  // gnuplot plots.
  //

  // Create the gnuplot helper.
  GnuplotHelper plotHelper;

  // Configure the plot.  Arguments include file prefix, plot title,
  // x-label, y-label, and output file type
  plotHelper.ConfigurePlot ("gnuplot-helper-example",
                            "Emitter Count vs. Time",
                            "Time (Seconds)",
                            "Emitter Count",
                            "png");

  // Create a probe.  Because the trace source we are interested in is 
  // of type uint32_t, we specify the type of probe to use by the first
  // argument specifying its ns3 TypeId.
  plotHelper.PlotProbe ("ns3::Uinteger32Probe",
                        "/Names/Emitter/Counter",
                        "Output",
                        "Emitter Count",
                        GnuplotAggregator::KEY_INSIDE);

(-)a/src/stats/helper/file-helper.h (-12 / +17 lines)

Lines 75-81	Link Here

/**

/**

   * \param typeId the type ID for the probe used when it is created.

   * \param typeId the type ID for the probe used when it is created.

   * \param path Config path to access the probe.

   * \param path Config path for underlying trace source to be probed

   * \param probeTraceSource the probe trace source to access.

   * \param probeTraceSource the probe trace source to access.

   * Creates output files generated by hooking the ns-3 trace source

   * Creates output files generated by hooking the ns-3 trace source

Lines 84-89	Link Here

   * in m_outputFileNameWithoutExtension plus ".txt", and will consist

   * in m_outputFileNameWithoutExtension plus ".txt", and will consist

   * of the 'newValue' at each timestamp.

   * of the 'newValue' at each timestamp.

   * This method will create one or more probes according to the TypeId

   * provided, connect the probe(s) to the trace source specified by

   * the config path, and hook the probeTraceSource(s) to the downstream

   * aggregator.

   * If the config path has more than one match in the system

   * If the config path has more than one match in the system

   * (e.g. there is a wildcard), then one output file for each match

   * (e.g. there is a wildcard), then one output file for each match

   * will be created.  The output file names will contain the text in

   * will be created.  The output file names will contain the text in

Lines 103-119	Link Here

103

                   const std::string &probeTraceSource);

108

                   const std::string &probeTraceSource);

104

109

105

/**

110

/**

106

   * \param typeId the type ID for the probe used when it is created.

107

   * \param probeName the probe's name.

108

   * \param path Config path to access the probe

109

110

   * \brief Adds a probe to be used to write values to files.

111

*/

112

  void AddProbe (const std::string &typeId,

113

                 const std::string &probeName,

114

                 const std::string &path);

115

116

/**

117

   * \param adaptorName the timeSeriesAdaptor's name.

111

   * \param adaptorName the timeSeriesAdaptor's name.

118

112

119

   * \brief Adds a time series adaptor to be used to write the file.

113

   * \brief Adds a time series adaptor to be used to write the file.

Lines 254-259	Link Here

254

private:

248

private:

255

/**

249

/**

256

   * \param typeId the type ID for the probe used when it is created.

250

   * \param typeId the type ID for the probe used when it is created.

251

   * \param probeName the probe's name.

252

   * \param path Config path to access the probe

253

254

   * \brief Adds a probe to be used to write values to files.

255

*/

256

  void AddProbe (const std::string &typeId,

257

                 const std::string &probeName,

258

                 const std::string &path);

259

260

/**

261

   * \param typeId the type ID for the probe used when it is created.

257

   * \param matchIdentifier this string is used to make the probe's

262

   * \param matchIdentifier this string is used to make the probe's

258

   * context be unique.

263

   * context be unique.

259

   * \param path Config path to access the probe.

264

   * \param path Config path to access the probe.




  // Get a pointer to the aggregator.
  Ptr<GnuplotAggregator> aggregator = GetAggregator ();

  // Add a subtitle to the title to show the trace source's path.
  aggregator->SetTitle ( m_title + " \\n\\nTrace Source Path: " + path);

  // Set the default dataset plotting style for the values.
  aggregator->Set2dDatasetDefaultStyle (Gnuplot2dDataset::LINES_POINTS);

  // See if the path has any wildcards.
  bool pathHasNoWildcards = path.find ("*") == std::string::npos;

  // Remove the last token from the path; this should correspond to the 
  // trace source attribute.
  size_t lastSlash = path.find_last_of ("/");
  if (lastSlash == std::string::npos)
    {

    }

  // See if there are any matches for the probe's path with the last
  // token removed; this corresponds to the traced object itself.
  NS_LOG_DEBUG ("Searching config database for trace source " << path);
  Config::MatchContainer matches = Config::LookupMatches (pathWithoutLastToken);
  uint32_t matchCount = matches.GetN ();
  NS_LOG_DEBUG ("Found " << matchCount << " matches for trace source " << path);

  // This is used to make the probe's context be unique.
  std::string matchIdentifier;

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

Lines 95-101	Link Here

/**

/**

   * \param typeId the type ID for the probe used when it is created.

   * \param typeId the type ID for the probe used when it is created.

   * \param path Config path to access the probe.

   * \param path Config path for underlying trace source to be probed

   * \param probeTraceSource the probe trace source to access.

   * \param probeTraceSource the probe trace source to access.

100

   * \param title the title to be associated to this dataset

100

   * \param title the title to be associated to this dataset

101

   * \param keyLocation the location of the key in the plot.

101

   * \param keyLocation the location of the key in the plot.

Lines 105-110	Link Here

105

   * will have the provided title, and will consist of the 'newValue'

105

   * will have the provided title, and will consist of the 'newValue'

106

   * at each timestamp.

106

   * at each timestamp.

107

108

   * This method will create one or more probes according to the TypeId

109

   * provided, connect the probe(s) to the trace source specified by

110

   * the config path, and hook the probeTraceSource(s) to the downstream

111

   * aggregator.

112

108

   * If the config path has more than one match in the system

113

   * If the config path has more than one match in the system

109

   * (e.g. there is a wildcard), then one dataset for each match will

114

   * (e.g. there is a wildcard), then one dataset for each match will

110

   * be plotted.  The dataset titles will be suffixed with the matched

115

   * be plotted.  The dataset titles will be suffixed with the matched

Lines 121-137	Link Here

121

                  enum GnuplotAggregator::KeyLocation keyLocation = GnuplotAggregator::KEY_INSIDE);

126

                  enum GnuplotAggregator::KeyLocation keyLocation = GnuplotAggregator::KEY_INSIDE);

122

127

123

/**

128

/**

124

   * \param typeId the type ID for the probe used when it is created.

125

   * \param probeName the probe's name.

126

   * \param path Config path to access the probe.

127

128

   * \brief Adds a probe to be used to make the plot.

129

*/

130

  void AddProbe (const std::string &typeId,

131

                 const std::string &probeName,

132

                 const std::string &path);

133

134

/**

135

   * \param adaptorName the timeSeriesAdaptor's name.

129

   * \param adaptorName the timeSeriesAdaptor's name.

136

130

137

   * \brief Adds a time series adaptor to be used to make the plot.

131

   * \brief Adds a time series adaptor to be used to make the plot.

Lines 155-160	Link Here

155

  Ptr<GnuplotAggregator> GetAggregator ();

149

  Ptr<GnuplotAggregator> GetAggregator ();

156

150

157

private:

151

private:

152

153

/**

154

   * \param typeId the type ID for the probe used when it is created.

155

   * \param probeName the probe's name.

156

   * \param path Config path to access the probe.

157

158

   * \brief Adds a probe to be used to make the plot.

159

*/

160

  void AddProbe (const std::string &typeId,

161

                 const std::string &probeName,

162

                 const std::string &path);

163

158

/**

164

/**

159

   * \brief Constructs the aggregator.

165

   * \brief Constructs the aggregator.

160

*/

166

*/

(-)a/src/stats/model/double-probe.cc (-2 / +2 lines)

Lines 84-90	Link Here

DoubleProbe::ConnectByObject (std::string traceSource, Ptr<Object> obj)

DoubleProbe::ConnectByObject (std::string traceSource, Ptr<Object> obj)

  NS_LOG_FUNCTION (this << traceSource << obj);

  NS_LOG_FUNCTION (this << traceSource << obj);

  NS_LOG_DEBUG ("Name of probe (if any) in names database: " << Names::FindPath (obj));

  NS_LOG_DEBUG ("Name of trace source (if any) in names database: " << Names::FindPath (obj));

  bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::DoubleProbe::TraceSink, this));

  bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::DoubleProbe::TraceSink, this));

  return connected;

  return connected;

Lines 93-99	Link Here

DoubleProbe::ConnectByPath (std::string path)

DoubleProbe::ConnectByPath (std::string path)

  NS_LOG_FUNCTION (this << path);

  NS_LOG_FUNCTION (this << path);

  NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);

  NS_LOG_DEBUG ("Name of trace source to search for in config database: " << path);

  Config::ConnectWithoutContext (path, MakeCallback (&ns3::DoubleProbe::TraceSink, this));

  Config::ConnectWithoutContext (path, MakeCallback (&ns3::DoubleProbe::TraceSink, this));

Return to bug 1997