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 
32 namespace ns3 {
33 
34 NS_LOG_COMPONENT_DEFINE ("TimeProbe");
35 
36 NS_OBJECT_ENSURE_REGISTERED (TimeProbe);
37 
38 TypeId
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 
64 double
65 TimeProbe::GetValue (void) const
66 {
67  NS_LOG_FUNCTION (this);
68  return m_output;
69 }
70 void
72 {
73  NS_LOG_FUNCTION (this << newVal.GetSeconds ());
74  m_output = newVal.GetSeconds ();
75 }
76 
77 void
78 TimeProbe::SetValueByPath (std::string path, Time newVal)
79 {
80  NS_LOG_FUNCTION (path << newVal.GetSeconds ());
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 
86 bool
87 TimeProbe::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 
95 void
96 TimeProbe::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 
103 void
104 TimeProbe::TraceSink (Time oldData, Time newData)
105 {
106  NS_LOG_FUNCTION (this << oldData.GetSeconds () << newData.GetSeconds ());
107  if (IsEnabled ())
108  {
109  m_output = newData.GetSeconds ();
110  }
111 }
112 
113 } // namespace ns3
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
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:102
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:73
#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
void TraceSink(Time oldData, Time newData)
Method to connect to an underlying ns3::TraceSource of type Time.
Definition: time-probe.cc:104
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
static TypeId GetTypeId()
Get the type ID.
Definition: time-probe.cc:39
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
double GetSeconds(void) const
Get an approximation of the time stored in this instance in the indicated unit.
Definition: nstime.h:355
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Definition: time-probe.cc:96
NS_ASSERT_MSG(false,"Ipv4AddressGenerator::MaskToIndex(): Impossible")
double GetValue(void) const
Definition: time-probe.cc:65
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1489
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:832
static void SetValueByPath(std::string path, Time value)
Set a probe value by its name in the Config system.
Definition: time-probe.cc:78
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:293
Every class exported by the ns3 library is enclosed in the ns3 namespace.
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:826
void SetValue(Time value)
Definition: time-probe.cc:71
This class is designed to probe an underlying ns3 TraceSource exporting an ns3::Time.
Definition: time-probe.h:48
TracedValue< double > m_output
Output trace source.
Definition: time-probe.h:105
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:270
virtual ~TimeProbe()
Definition: time-probe.cc:59
virtual bool IsEnabled(void) const
Definition: probe.cc:64
a unique identifier for an interface.
Definition: type-id.h:58
Base class for probes.
Definition: probe.h:39
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915