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