bug 1997: fix PlotProbe() documentation and usage for GnuplotHelper and FileHelper
/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
* Copyright (c) 2013 University of Washington
*
* 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
*
* This is based on double-probe-example.cc.
*
* Author: Mitch Watrous (watrous@u.washington.edu)
*/
/*
* This example is designed to show the main features of an
* ns3::FileHelper.
*/
#include <string>
#include "ns3/core-module.h"
#include "ns3/stats-module.h"
using namespace ns3;
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:
static TypeId GetTypeId (void);
Emitter ();
private:
void DoInitialize (void);
void Count (void);
TracedValue<uint32_t> m_counter;
Ptr<ExponentialRandomVariable> m_var;
};
NS_OBJECT_ENSURE_REGISTERED (Emitter);
TypeId
Emitter::GetTypeId (void)
{
static TypeId tid = TypeId ("ns3::Emitter")
.AddConstructor<Emitter> ()
.SetParent<Object> ()
.AddTraceSource ("Counter",
"sample counter",
MakeTraceSourceAccessor (&Emitter::m_counter),
"ns3::TracedValue::DoubleCallback")
;
return tid;
}
Emitter::Emitter (void)
{
NS_LOG_FUNCTION (this);
m_counter = 0;
m_var = CreateObject<ExponentialRandomVariable> ();
}
void
Emitter::DoInitialize (void)
{
NS_LOG_FUNCTION (this);
Simulator::Schedule (Seconds (m_var->GetValue ()), &Emitter::Count, this);
}
void
Emitter::Count (void)
{
NS_LOG_FUNCTION (this);
NS_LOG_DEBUG ("Counting at " << Simulator::Now ().GetSeconds ());
m_counter += 1.0;
Simulator::Schedule (Seconds (m_var->GetValue ()), &Emitter::Count, this);
}
int main (int argc, char *argv[])
{
CommandLine cmd;
cmd.Parse (argc, argv);
//
// This Emitter has a trace source object that will emit values at
// random times.
//
Ptr<Emitter> emitter = CreateObject<Emitter> ();
Names::Add ("/Names/Emitter", emitter);
//
// This file helper will be used to put data values into a file.
//
// Create the file helper.
FileHelper fileHelper;
// Configure the file to be written.
fileHelper.ConfigureFile ("file-helper-example",
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
// it won't get started automatically, so we need to do this ourselves
Simulator::Schedule (Seconds (0.0), &Emitter::Initialize, emitter);
Simulator::Stop (Seconds (100.0));
Simulator::Run ();
Simulator::Destroy ();
return 0;
}