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 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
7 * Tiago G. Rodrigues (tgr002@bucknell.edu)
8 *
9 * Modified by: Mitch Watrous (watrous@u.washington.edu)
10 *
11 */
12
13#include "time-probe.h"
14
15#include "ns3/config.h"
16#include "ns3/log.h"
17#include "ns3/names.h"
18#include "ns3/object.h"
19#include "ns3/trace-source-accessor.h"
20
21namespace ns3
22{
23
24NS_LOG_COMPONENT_DEFINE("TimeProbe");
25
27
28TypeId
30{
31 static TypeId tid = TypeId("ns3::TimeProbe")
33 .SetGroupName("Stats")
34 .AddConstructor<TimeProbe>()
35 .AddTraceSource("Output",
36 "The double valued (units of seconds) probe output",
38 "ns3::TracedValueCallback::Double");
39 return tid;
40}
41
43{
44 NS_LOG_FUNCTION(this);
45 m_output = 0;
46}
47
52
53double
55{
56 NS_LOG_FUNCTION(this);
57 return m_output;
58}
59
60void
62{
63 NS_LOG_FUNCTION(this << newVal.As(Time::S));
64 m_output = newVal.GetSeconds();
65}
66
67void
68TimeProbe::SetValueByPath(std::string path, Time newVal)
69{
70 NS_LOG_FUNCTION(path << newVal.As(Time::S));
72 NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
73 probe->SetValue(newVal);
74}
75
76bool
77TimeProbe::ConnectByObject(std::string traceSource, Ptr<Object> obj)
78{
79 NS_LOG_FUNCTION(this << traceSource << obj);
80 NS_LOG_DEBUG("Name of trace source (if any) in names database: " << Names::FindPath(obj));
81 bool connected =
82 obj->TraceConnectWithoutContext(traceSource,
84 return connected;
85}
86
87void
88TimeProbe::ConnectByPath(std::string path)
89{
90 NS_LOG_FUNCTION(this << path);
91 NS_LOG_DEBUG("Name of trace source to search for in config database: " << path);
93}
94
95void
97{
98 NS_LOG_FUNCTION(this << oldData.As(Time::S) << newData.As(Time::S));
99 if (IsEnabled())
100 {
101 m_output = newData.GetSeconds();
102 }
103}
104
105} // namespace ns3
static Ptr< T > Find(std::string path)
Given a name path string, look to see if there's an object in the system with that associated to it.
Definition names.h:443
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:825
Base class for probes.
Definition probe.h:30
bool IsEnabled() const override
Definition probe.cc:54
Smart pointer class similar to boost::intrusive_ptr.
Simulation virtual time values and global simulation resolution.
Definition nstime.h:94
TimeWithUnit As(const Unit unit=Time::AUTO) const
Attach a unit to a Time, to facilitate output in a specific unit.
Definition time.cc:404
double GetSeconds() const
Get an approximation of the time stored in this instance in the indicated unit.
Definition nstime.h:392
@ S
second
Definition nstime.h:105
This class is designed to probe an underlying ns3 TraceSource exporting an ns3::Time.
Definition time-probe.h:39
static TypeId GetTypeId()
Get the type ID.
Definition time-probe.cc:29
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
Definition time-probe.cc:77
void SetValue(Time value)
Definition time-probe.cc:61
double GetValue() const
Definition time-probe.cc:54
TracedValue< double > m_output
Output trace source.
Definition time-probe.h:95
~TimeProbe() override
Definition time-probe.cc:48
void TraceSink(Time oldData, Time newData)
Method to connect to an underlying ns3::TraceSource of type Time.
Definition time-probe.cc:96
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
Definition time-probe.cc:88
static void SetValueByPath(std::string path, Time value)
Set a probe value by its name in the Config system.
Definition time-probe.cc:68
a unique identifier for an interface.
Definition type-id.h:48
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition type-id.cc:1001
#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:75
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition config.cc:943
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition log.h:191
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition log.h:257
#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:35
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:684