A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
time-probe.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011 Bucknell University
3 *
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 as
6 * published by the Free Software Foundation;
7 *
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
12 *
13 * You should have received a copy of the GNU General Public License
14 * along with this program; if not, write to the Free Software
15 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 *
17 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
18 * Tiago G. Rodrigues (tgr002@bucknell.edu)
19 *
20 * Modified by: Mitch Watrous (watrous@u.washington.edu)
21 *
22 */
23
24#include "time-probe.h"
25
26#include "ns3/config.h"
27#include "ns3/log.h"
28#include "ns3/names.h"
29#include "ns3/object.h"
30#include "ns3/trace-source-accessor.h"
31
32namespace ns3
33{
34
35NS_LOG_COMPONENT_DEFINE("TimeProbe");
36
38
39TypeId
41{
42 static TypeId tid = TypeId("ns3::TimeProbe")
44 .SetGroupName("Stats")
45 .AddConstructor<TimeProbe>()
46 .AddTraceSource("Output",
47 "The double valued (units of seconds) probe output",
49 "ns3::TracedValueCallback::Double");
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}
70
71void
73{
74 NS_LOG_FUNCTION(this << newVal.As(Time::S));
75 m_output = newVal.GetSeconds();
76}
77
78void
79TimeProbe::SetValueByPath(std::string path, Time newVal)
80{
81 NS_LOG_FUNCTION(path << newVal.As(Time::S));
82 Ptr<TimeProbe> probe = Names::Find<TimeProbe>(path);
83 NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
84 probe->SetValue(newVal);
85}
86
87bool
88TimeProbe::ConnectByObject(std::string traceSource, Ptr<Object> obj)
89{
90 NS_LOG_FUNCTION(this << traceSource << obj);
91 NS_LOG_DEBUG("Name of trace source (if any) in names database: " << Names::FindPath(obj));
92 bool connected =
93 obj->TraceConnectWithoutContext(traceSource,
95 return connected;
96}
97
98void
99TimeProbe::ConnectByPath(std::string path)
100{
101 NS_LOG_FUNCTION(this << path);
102 NS_LOG_DEBUG("Name of trace source to search for in config database: " << path);
104}
105
106void
108{
109 NS_LOG_FUNCTION(this << oldData.As(Time::S) << newData.As(Time::S));
110 if (IsEnabled())
111 {
112 m_output = newData.GetSeconds();
113 }
114}
115
116} // 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:836
Base class for probes.
Definition: probe.h:41
bool IsEnabled() const override
Definition: probe.cc:65
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:77
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
Definition: time.cc:415
double GetSeconds() const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:403
@ S
second
Definition: nstime.h:116
This class is designed to probe an underlying ns3 TraceSource exporting an ns3::Time.
Definition: time-probe.h:50
static TypeId GetTypeId()
Get the type ID.
Definition: time-probe.cc:40
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
Definition: time-probe.cc:88
void SetValue(Time value)
Definition: time-probe.cc:72
double GetValue() const
Definition: time-probe.cc:65
TracedValue< double > m_output
Output trace source.
Definition: time-probe.h:106
~TimeProbe() override
Definition: time-probe.cc:59
void TraceSink(Time oldData, Time newData)
Method to connect to an underlying ns3::TraceSource of type Time.
Definition: time-probe.cc:107
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
Definition: time-probe.cc:99
static void SetValueByPath(std::string path, Time value)
Set a probe value by its name in the Config system.
Definition: time-probe.cc:79
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:932
#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:86
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:954
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:268
#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:46
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, Args... > MakeCallback(R(T::*memPtr)(Args...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:704