A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
boolean-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/boolean-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 NS_LOG_COMPONENT_DEFINE ("BooleanProbe");
32 
33 namespace ns3 {
34 
35 NS_OBJECT_ENSURE_REGISTERED (BooleanProbe)
36  ;
37 
38 TypeId
40 {
41  static TypeId tid = TypeId ("ns3::BooleanProbe")
42  .SetParent<Probe> ()
43  .AddConstructor<BooleanProbe> ()
44  .AddTraceSource ( "Output",
45  "The bool that serves as output for this probe",
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 
62 bool
64 {
65  NS_LOG_FUNCTION (this);
66  return m_output;
67 }
68 void
70 {
71  NS_LOG_FUNCTION (this << newVal);
72  m_output = newVal;
73 }
74 
75 void
76 BooleanProbe::SetValueByPath (std::string path, bool newVal)
77 {
78  NS_LOG_FUNCTION (path << newVal);
79  Ptr<BooleanProbe> probe = Names::Find<BooleanProbe> (path);
80  NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
81  probe->SetValue (newVal);
82 }
83 
84 bool
85 BooleanProbe::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::BooleanProbe::TraceSink, this));
90  return connected;
91 }
92 
93 void
94 BooleanProbe::ConnectByPath (std::string path)
95 {
96  NS_LOG_FUNCTION (this << path);
97  NS_LOG_DEBUG ("Name of probe to search for in config database: " << path);
99 }
100 
101 void
102 BooleanProbe::TraceSink (bool oldData, bool newData)
103 {
104  NS_LOG_FUNCTION (this << oldData << newData);
105  if (IsEnabled ())
106  {
107  m_output = newData;
108  }
109 }
110 
111 } // namespace ns3
smart pointer class similar to boost::intrusive_ptr
Definition: ptr.h:59
#define NS_LOG_FUNCTION(parameters)
Definition: log.h:345
NS_OBJECT_ENSURE_REGISTERED(NullMessageSimulatorImpl)
void SetValue(bool value)
void TraceSink(bool oldData, bool newData)
Method to connect to an underlying ns3::TraceSource of type bool.
virtual ~BooleanProbe()
Callback< R > MakeCallback(R(T::*memPtr)(void), OBJ objPtr)
Definition: callback.h:1238
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Definition: object-base.cc:269
bool GetValue(void) const
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:672
static TypeId GetTypeId()
Get the type ID.
#define NS_ASSERT_MSG(condition, message)
Definition: assert.h:86
#define NS_LOG_DEBUG(msg)
Definition: log.h:289
TracedValue< bool > m_output
Output trace source.
virtual bool IsEnabled(void) const
Definition: probe.cc:64
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
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:611
NS_LOG_COMPONENT_DEFINE("BooleanProbe")
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:717
static void SetValueByPath(std::string path, bool 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