A Discrete-Event Network Simulator
API
double-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 #include "ns3/double-probe.h"
25 #include "ns3/object.h"
26 #include "ns3/log.h"
27 #include "ns3/names.h"
28 #include "ns3/config.h"
29 #include "ns3/trace-source-accessor.h"
30 
31 namespace ns3 {
32 
33 NS_LOG_COMPONENT_DEFINE ("DoubleProbe");
34 
35 NS_OBJECT_ENSURE_REGISTERED (DoubleProbe);
36 
37 TypeId
39 {
40  static TypeId tid = TypeId ("ns3::DoubleProbe")
41  .SetParent<Probe> ()
42  .SetGroupName ("Stats")
43  .AddConstructor<DoubleProbe> ()
44  .AddTraceSource ( "Output",
45  "The double that serves as output for this probe",
47  "ns3::TracedValueCallback::Double")
48  ;
49  return tid;
50 }
51 
53 {
54  NS_LOG_FUNCTION (this);
55  m_output = 0;
56 }
57 
59 {
60  NS_LOG_FUNCTION (this);
61 }
62 
63 double
65 {
66  NS_LOG_FUNCTION (this);
67  return m_output;
68 }
69 void
70 DoubleProbe::SetValue (double newVal)
71 {
72  NS_LOG_FUNCTION (this << newVal);
73  m_output = newVal;
74 }
75 
76 void
77 DoubleProbe::SetValueByPath (std::string path, double newVal)
78 {
79  NS_LOG_FUNCTION (path << newVal);
80  Ptr<DoubleProbe> probe = Names::Find<DoubleProbe> (path);
81  NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
82  probe->SetValue (newVal);
83 }
84 
85 bool
86 DoubleProbe::ConnectByObject (std::string traceSource, Ptr<Object> obj)
87 {
88  NS_LOG_FUNCTION (this << traceSource << obj);
89  NS_LOG_DEBUG ("Name of trace source (if any) in names database: " << Names::FindPath (obj));
90  bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::DoubleProbe::TraceSink, this));
91  return connected;
92 }
93 
94 void
95 DoubleProbe::ConnectByPath (std::string path)
96 {
97  NS_LOG_FUNCTION (this << path);
98  NS_LOG_DEBUG ("Name of trace source to search for in config database: " << path);
100 }
101 
102 void
103 DoubleProbe::TraceSink (double oldData, double newData)
104 {
105  NS_LOG_FUNCTION (this << oldData << newData);
106  if (IsEnabled ())
107  {
108  m_output = newData;
109  }
110 }
111 
112 } // namespace ns3
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 SetValue(double value)
Definition: double-probe.cc:70
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Definition: double-probe.cc:95
NS_ASSERT_MSG(false,"Ipv4AddressGenerator::MaskToIndex(): Impossible")
static void SetValueByPath(std::string path, double value)
Set a probe value by its name in the Config system.
Definition: double-probe.cc:77
static TypeId GetTypeId()
Get the type ID.
Definition: double-probe.cc:38
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
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
TracedValue< double > m_output
Output trace source.
Definition: double-probe.h:104
This class is designed to probe an underlying ns3 TraceSource exporting a double. ...
Definition: double-probe.h:47
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Definition: double-probe.cc:86
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:270
void TraceSink(double oldData, double newData)
Method to connect to an underlying ns3::TraceSource of type double.
virtual ~DoubleProbe()
Definition: double-probe.cc:58
double GetValue(void) const
Definition: double-probe.cc:64
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