A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
uinteger-32-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/uinteger-32-probe.h"
25 #include "ns3/log.h"
26 #include "ns3/names.h"
27 #include "ns3/config.h"
28 #include "ns3/trace-source-accessor.h"
29 
30 NS_LOG_COMPONENT_DEFINE ("Uinteger32Probe");
31 
32 namespace ns3 {
33 
34 NS_OBJECT_ENSURE_REGISTERED (Uinteger32Probe);
35 
36 TypeId
38 {
39  static TypeId tid = TypeId ("ns3::Uinteger32Probe")
40  .SetParent<Probe> ()
41  .AddConstructor<Uinteger32Probe> ()
42  .AddTraceSource ( "Output",
43  "The uint32_t that serves as output for this probe",
45  ;
46  return tid;
47 }
48 
50 {
51  NS_LOG_FUNCTION (this);
52  m_output = 0;
53 }
54 
56 {
57  NS_LOG_FUNCTION (this);
58 }
59 
60 uint32_t
62 {
63  NS_LOG_FUNCTION (this);
64  return m_output;
65 }
66 void
67 Uinteger32Probe::SetValue (uint32_t newVal)
68 {
69  NS_LOG_FUNCTION (this << newVal);
70  m_output = newVal;
71 }
72 
73 void
74 Uinteger32Probe::SetValueByPath (std::string path, uint32_t newVal)
75 {
76  NS_LOG_FUNCTION (path << newVal);
77  Ptr<Uinteger32Probe> probe = Names::Find<Uinteger32Probe> (path);
78  NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
79  probe->SetValue (newVal);
80 }
81 
82 bool
83 Uinteger32Probe::ConnectByObject (std::string traceSource, Ptr<Object> obj)
84 {
85  NS_LOG_FUNCTION (this << traceSource << obj);
86  NS_LOG_DEBUG ("Name of probe (if any) in names database: " << Names::FindPath (obj));
87  bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::Uinteger32Probe::TraceSink, this));
88  return connected;
89 }
90 
91 void
93 {
94  NS_LOG_FUNCTION (this << path);
95  NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);
97 }
98 
99 void
100 Uinteger32Probe::TraceSink (uint32_t oldData, uint32_t newData)
101 {
102  NS_LOG_FUNCTION (this << oldData << newData);
103  if (IsEnabled ())
104  {
105  m_output = newData;
106  }
107 }
108 
109 } // namespace ns3
static TypeId GetTypeId()
Get the type ID.
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:60
#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 the class in the ns-3 factory.
Definition: object-base.h:38
static void SetValueByPath(std::string path, uint32_t value)
Set a probe value by its name in the Config system.
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:170
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1242
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Definition: object-base.cc:284
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
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:671
#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:84
TracedValue< uint32_t > m_output
Output trace source.
uint32_t GetValue(void) const
void TraceSink(uint32_t oldData, uint32_t newData)
Method to connect to an underlying ns3::TraceSource of type uint32_t.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:213
virtual bool IsEnabled(void) const
Definition: probe.cc:63
a unique identifier for an interface.
Definition: type-id.h:49
Base class for probes.
Definition: probe.h:39
TypeId SetParent(TypeId tid)
Definition: type-id.cc:610
void SetValue(uint32_t value)
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:717