A Discrete-Event Network Simulator
API
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
30namespace ns3 {
31
32NS_LOG_COMPONENT_DEFINE ("Uinteger32Probe");
33
34NS_OBJECT_ENSURE_REGISTERED (Uinteger32Probe);
35
36TypeId
38{
39 static TypeId tid = TypeId ("ns3::Uinteger32Probe")
40 .SetParent<Probe> ()
41 .SetGroupName ("Stats")
42 .AddConstructor<Uinteger32Probe> ()
43 .AddTraceSource ( "Output",
44 "The uint32_t that serves as output for this probe",
46 "ns3::TracedValueCallback::Uint32")
47 ;
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
64{
65 NS_LOG_FUNCTION (this);
66 return m_output;
67}
68void
70{
71 NS_LOG_FUNCTION (this << newVal);
72 m_output = newVal;
73}
74
75void
76Uinteger32Probe::SetValueByPath (std::string path, uint32_t newVal)
77{
78 NS_LOG_FUNCTION (path << newVal);
79 Ptr<Uinteger32Probe> probe = Names::Find<Uinteger32Probe> (path);
80 NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
81 probe->SetValue (newVal);
82}
83
84bool
85Uinteger32Probe::ConnectByObject (std::string traceSource, Ptr<Object> obj)
86{
87 NS_LOG_FUNCTION (this << traceSource << obj);
88 NS_LOG_DEBUG ("Name of probe (if any) in names database: " << Names::FindPath (obj));
89 bool connected = obj->TraceConnectWithoutContext (traceSource, MakeCallback (&ns3::Uinteger32Probe::TraceSink, this));
90 return connected;
91}
92
93void
95{
96 NS_LOG_FUNCTION (this << path);
97 NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);
99}
100
101void
103{
104 NS_LOG_FUNCTION (this << oldData << newData);
105 if (IsEnabled ())
106 {
107 m_output = newData;
108 }
109}
110
111} // 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:824
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:364
Base class for probes.
Definition: probe.h:40
virtual bool IsEnabled(void) const
Definition: probe.cc:64
Smart pointer class similar to boost::intrusive_ptr.
Definition: ptr.h:74
a unique identifier for an interface.
Definition: type-id.h:59
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:922
This class is designed to probe an underlying ns3 TraceSource exporting an uint32_t.
static void SetValueByPath(std::string path, uint32_t value)
Set a probe value by its name in the Config system.
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
void SetValue(uint32_t value)
static TypeId GetTypeId()
Get the type ID.
void TraceSink(uint32_t oldData, uint32_t newData)
Method to connect to an underlying ns3::TraceSource of type uint32_t.
uint32_t GetValue(void) const
TracedValue< uint32_t > m_output
Output trace source.
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
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:88
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:901
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:205
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:273
#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
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, Ts... > MakeCallback(R(T::*memPtr)(Ts...), OBJ objPtr)
Build Callbacks for class method members which take varying numbers of arguments and potentially retu...
Definition: callback.h:1648