A Discrete-Event Network Simulator
API
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 namespace ns3 {
31 
32 NS_LOG_COMPONENT_DEFINE ("Uinteger8Probe");
33 
34 NS_OBJECT_ENSURE_REGISTERED (Uinteger8Probe);
35 
36 TypeId
38 {
39  static TypeId tid = TypeId ("ns3::Uinteger8Probe")
40  .SetParent<Probe> ()
41  .SetGroupName ("Stats")
42  .AddConstructor<Uinteger8Probe> ()
43  .AddTraceSource ( "Output",
44  "The uint8_t that serves as output for this probe",
46  "ns3::TracedValueCallback::Uint8")
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 uint8_t
64 {
65  NS_LOG_FUNCTION (this);
66  return m_output;
67 }
68 void
69 Uinteger8Probe::SetValue (uint8_t newVal)
70 {
71  NS_LOG_FUNCTION (this << newVal);
72  m_output = newVal;
73 }
74 
75 void
76 Uinteger8Probe::SetValueByPath (std::string path, uint8_t newVal)
77 {
78  NS_LOG_FUNCTION (path << newVal);
79  Ptr<Uinteger8Probe> probe = Names::Find<Uinteger8Probe> (path);
80  NS_ASSERT_MSG (probe, "Error: Can't find probe for path " << path);
81  probe->SetValue (newVal);
82 }
83 
84 bool
85 Uinteger8Probe::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::Uinteger8Probe::TraceSink, this));
90  return connected;
91 }
92 
93 void
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 Uinteger8Probe::TraceSink (uint8_t oldData, uint8_t 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:73
void SetValue(uint8_t value)
#define NS_LOG_FUNCTION(parameters)
If log level LOG_FUNCTION is enabled, this macro will output all input parameters separated by "...
static TypeId GetTypeId()
Get the type ID.
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
#define NS_OBJECT_ENSURE_REGISTERED(type)
Register an Object subclass with the TypeId system.
Definition: object-base.h:45
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition: log.h:202
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Ptr< const TraceSourceAccessor > MakeTraceSourceAccessor(T a)
Create a TraceSourceAccessor which will control access to the underlying trace source.
NS_ASSERT_MSG(false,"Ipv4AddressGenerator::MaskToIndex(): Impossible")
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:1489
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition: config.cc:832
TracedValue< uint8_t > m_output
Output trace source.
bool TraceConnectWithoutContext(std::string name, const CallbackBase &cb)
Connect a TraceSource to a Callback without a context.
Definition: object-base.cc:293
Every class exported by the ns3 library is enclosed in the ns3 namespace.
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:826
This class is designed to probe an underlying ns3 TraceSource exporting an uint8_t.
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition: log.h:270
uint8_t GetValue(void) const
virtual bool IsEnabled(void) const
Definition: probe.cc:64
a unique identifier for an interface.
Definition: type-id.h:58
Base class for probes.
Definition: probe.h:39
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition: type-id.cc:915
void TraceSink(uint8_t oldData, uint8_t newData)
Method to connect to an underlying ns3::TraceSource of type uint8_t.