A Discrete-Event Network Simulator
API
time-probe.cc
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2011 Bucknell University
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
19 * Tiago G. Rodrigues (tgr002@bucknell.edu)
20 *
21 * Modified by: Mitch Watrous (watrous@u.washington.edu)
22 *
23 */
24
25#include "ns3/time-probe.h"
26#include "ns3/object.h"
27#include "ns3/log.h"
28#include "ns3/names.h"
29#include "ns3/config.h"
30#include "ns3/trace-source-accessor.h"
31
32namespace ns3 {
33
34NS_LOG_COMPONENT_DEFINE ("TimeProbe");
35
37
38TypeId
40{
41 static TypeId tid = TypeId ("ns3::TimeProbe")
42 .SetParent<Probe> ()
43 .SetGroupName ("Stats")
44 .AddConstructor<TimeProbe> ()
45 .AddTraceSource ("Output",
46 "The double valued (units of seconds) probe output",
48 "ns3::TracedValueCallback::Double")
49 ;
50 return tid;
51}
52
54{
55 NS_LOG_FUNCTION (this);
56 m_output = 0;
57}
58
60{
61 NS_LOG_FUNCTION (this);
62}
63
64double
66{
67 NS_LOG_FUNCTION (this);
68 return m_output;
69}
70void
72{
73 NS_LOG_FUNCTION (this << newVal.As (Time::S));
74 m_output = newVal.GetSeconds ();
75}
76
77void
78TimeProbe::SetValueByPath (std::string path, Time newVal)
79{
80 NS_LOG_FUNCTION (path << newVal.As (Time::S));
81 Ptr<TimeProbe> probe = Names::Find<TimeProbe> (path);
82 NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
83 probe->SetValue (newVal);
84}
85
86bool
87TimeProbe::ConnectByObject (std::string traceSource, Ptr<Object> obj)
88{
89 NS_LOG_FUNCTION (this << traceSource << obj);
90 NS_LOG_DEBUG ("Name of trace source (if any) in names database: " << Names::FindPath (obj));
91 bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::TimeProbe::TraceSink, this));
92 return connected;
93}
94
95void
96TimeProbe::ConnectByPath (std::string path)
97{
98 NS_LOG_FUNCTION (this << path);
99 NS_LOG_DEBUG ("Name of trace source to search for in config database: " << path);
101}
102
103void
105{
106 NS_LOG_FUNCTION (this << oldData.As (Time::S) << newData.As (Time::S));
107 if (IsEnabled ())
108 {
109 m_output = newData.GetSeconds ();
110 }
111}
112
113} // namespace ns3
static std::string FindPath(Ptr< Object > object)
Given a pointer to an object, look to see if that object has a name associated with it and return the...
Definition: names.cc:824
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:364
Base class for probes.
Definition: probe.h:40
virtual bool IsEnabled(void) const
Definition: probe.cc:64
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:103
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:379
@ S
second
Definition: nstime.h:114
TimeWithUnit As(const enum Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
Definition: time.cc:418
This class is designed to probe an underlying ns3 TraceSource exporting an ns3::Time.
Definition: time-probe.h:49
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Definition: time-probe.cc:87
static TypeId GetTypeId()
Get the type ID.
Definition: time-probe.cc:39
virtual ~TimeProbe()
Definition: time-probe.cc:59
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Definition: time-probe.cc:96
void SetValue(Time value)
Definition: time-probe.cc:71
TracedValue< double > m_output
Output trace source.
Definition: time-probe.h:105
void TraceSink(Time oldData, Time newData)
Method to connect to an underlying ns3::TraceSource of type Time.
Definition: time-probe.cc:104
double GetValue(void) const
Definition: time-probe.cc:65
static void SetValueByPath(std::string path, Time value)
Set a probe value by its name in the Config system.
Definition: time-probe.cc:78
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
#define NS_ASSERT_MSG(condition, message)
At runtime, in debugging builds, if this condition is not true, the program prints the message to out...
Definition: assert.h:88
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:901
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:273
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by ",...
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
Callback< R, Ts... > MakeCallback(R(T::*memPtr)(Ts...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:1648