A Discrete-Event Network Simulator
API
uinteger-8-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 #include "uinteger-8-probe.h"
24 
25 #include "ns3/config.h"
26 #include "ns3/log.h"
27 #include "ns3/names.h"
28 #include "ns3/trace-source-accessor.h"
29 
30 namespace ns3
31 {
32 
33 NS_LOG_COMPONENT_DEFINE("Uinteger8Probe");
34 
35 NS_OBJECT_ENSURE_REGISTERED(Uinteger8Probe);
36 
37 TypeId
39 {
40  static TypeId tid = TypeId("ns3::Uinteger8Probe")
41  .SetParent<Probe>()
42  .SetGroupName("Stats")
43  .AddConstructor<Uinteger8Probe>()
44  .AddTraceSource("Output",
45  "The uint8_t that serves as output for this probe",
47  "ns3::TracedValueCallback::Uint8");
48  return tid;
49 }
50 
52 {
53  NS_LOG_FUNCTION(this);
54  m_output = 0;
55 }
56 
58 {
59  NS_LOG_FUNCTION(this);
60 }
61 
62 uint8_t
64 {
65  NS_LOG_FUNCTION(this);
66  return m_output;
67 }
68 
69 void
70 Uinteger8Probe::SetValue(uint8_t newVal)
71 {
72  NS_LOG_FUNCTION(this << newVal);
73  m_output = newVal;
74 }
75 
76 void
77 Uinteger8Probe::SetValueByPath(std::string path, uint8_t newVal)
78 {
79  NS_LOG_FUNCTION(path << newVal);
80  Ptr<Uinteger8Probe> probe = Names::Find<Uinteger8Probe>(path);
81  NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
82  probe->SetValue(newVal);
83 }
84 
85 bool
86 Uinteger8Probe::ConnectByObject(std::string traceSource, Ptr<Object> obj)
87 {
88  NS_LOG_FUNCTION(this << traceSource << obj);
89  NS_LOG_DEBUG("Name of probe (if any) in names database: " << Names::FindPath(obj));
90  bool connected =
91  obj->TraceConnectWithoutContext(traceSource,
93  return connected;
94 }
95 
96 void
98 {
99  NS_LOG_FUNCTION(this << path);
100  NS_LOG_DEBUG("Name of probe to search for in config database: " << path);
102 }
103 
104 void
105 Uinteger8Probe::TraceSink(uint8_t oldData, uint8_t newData)
106 {
107  NS_LOG_FUNCTION(this << oldData << newData);
108  if (IsEnabled())
109  {
110  m_output = newData;
111  }
112 }
113 
114 } // 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
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:315
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
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:931
This class is designed to probe an underlying ns3 TraceSource exporting an uint8_t.
uint8_t GetValue() const
void SetValue(uint8_t value)
static void SetValueByPath(std::string path, uint8_t value)
Set a probe value by its name in the Config system.
static TypeId GetTypeId()
Get the type ID.
void TraceSink(uint8_t oldData, uint8_t newData)
Method to connect to an underlying ns3::TraceSource of type uint8_t.
TracedValue< uint8_t > m_output
Output trace source.
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
#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:950
#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