A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
boolean-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 "boolean-probe.h"
24
25#include "ns3/config.h"
26#include "ns3/log.h"
27#include "ns3/names.h"
28#include "ns3/object.h"
29#include "ns3/trace-source-accessor.h"
30
31namespace ns3
32{
33
34NS_LOG_COMPONENT_DEFINE("BooleanProbe");
35
36NS_OBJECT_ENSURE_REGISTERED(BooleanProbe);
37
38TypeId
40{
41 static TypeId tid = TypeId("ns3::BooleanProbe")
43 .SetGroupName("Stats")
44 .AddConstructor<BooleanProbe>()
45 .AddTraceSource("Output",
46 "The bool that serves as output for this probe",
48 "ns3::TracedValueCallback::Bool");
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
63bool
65{
66 NS_LOG_FUNCTION(this);
67 return m_output;
68}
69
70void
72{
73 NS_LOG_FUNCTION(this << newVal);
74 m_output = newVal;
75}
76
77void
78BooleanProbe::SetValueByPath(std::string path, bool newVal)
79{
80 NS_LOG_FUNCTION(path << newVal);
81 Ptr<BooleanProbe> probe = Names::Find<BooleanProbe>(path);
82 NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
83 probe->SetValue(newVal);
84}
85
86bool
87BooleanProbe::ConnectByObject(std::string traceSource, Ptr<Object> obj)
88{
89 NS_LOG_FUNCTION(this << traceSource << obj);
90 NS_LOG_DEBUG("Name of probe (if any) in names database: " << Names::FindPath(obj));
91 bool connected =
92 obj->TraceConnectWithoutContext(traceSource,
94 return connected;
95}
96
97void
99{
100 NS_LOG_FUNCTION(this << path);
101 NS_LOG_DEBUG("Name of probe to search for in config database: " << path);
103}
104
105void
106BooleanProbe::TraceSink(bool oldData, bool newData)
107{
108 NS_LOG_FUNCTION(this << oldData << newData);
109 if (IsEnabled())
110 {
111 m_output = newData;
112 }
113}
114
115} // namespace ns3
This class is designed to probe an underlying ns3 TraceSource exporting a bool.
Definition: boolean-probe.h:49
static void SetValueByPath(std::string path, bool value)
Set a probe value by its name in the Config system.
TracedValue< bool > m_output
Output trace source.
static TypeId GetTypeId()
Get the type ID.
void TraceSink(bool oldData, bool newData)
Method to connect to an underlying ns3::TraceSource of type bool.
void SetValue(bool value)
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
bool GetValue() const
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
~BooleanProbe() override
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
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:932
#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:954
#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