A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
uinteger-8-probe.cc
Go to the documentation of this file.
1/*
2 * Copyright (c) 2011 Bucknell University
3 *
4 * SPDX-License-Identifier: GPL-2.0-only
5 *
6 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
7 * Tiago G. Rodrigues (tgr002@bucknell.edu)
8 *
9 * Modified by: Mitch Watrous (watrous@u.washington.edu)
10 */
11
12#include "uinteger-8-probe.h"
13
14#include "ns3/config.h"
15#include "ns3/log.h"
16#include "ns3/names.h"
17#include "ns3/trace-source-accessor.h"
18
19namespace ns3
20{
21
22NS_LOG_COMPONENT_DEFINE("Uinteger8Probe");
23
24NS_OBJECT_ENSURE_REGISTERED(Uinteger8Probe);
25
26TypeId
28{
29 static TypeId tid = TypeId("ns3::Uinteger8Probe")
31 .SetGroupName("Stats")
32 .AddConstructor<Uinteger8Probe>()
33 .AddTraceSource("Output",
34 "The uint8_t that serves as output for this probe",
36 "ns3::TracedValueCallback::Uint8");
37 return tid;
38}
39
45
50
51uint8_t
53{
54 NS_LOG_FUNCTION(this);
55 return m_output;
56}
57
58void
60{
61 NS_LOG_FUNCTION(this << newVal);
62 m_output = newVal;
63}
64
65void
66Uinteger8Probe::SetValueByPath(std::string path, uint8_t newVal)
67{
68 NS_LOG_FUNCTION(path << newVal);
70 NS_ASSERT_MSG(probe, "Error: Can't find probe for path " << path);
71 probe->SetValue(newVal);
72}
73
74bool
75Uinteger8Probe::ConnectByObject(std::string traceSource, Ptr<Object> obj)
76{
77 NS_LOG_FUNCTION(this << traceSource << obj);
78 NS_LOG_DEBUG("Name of probe (if any) in names database: " << Names::FindPath(obj));
79 bool connected =
80 obj->TraceConnectWithoutContext(traceSource,
82 return connected;
83}
84
85void
87{
88 NS_LOG_FUNCTION(this << path);
89 NS_LOG_DEBUG("Name of probe to search for in config database: " << path);
91}
92
93void
94Uinteger8Probe::TraceSink(uint8_t oldData, uint8_t newData)
95{
96 NS_LOG_FUNCTION(this << oldData << newData);
97 if (IsEnabled())
98 {
99 m_output = newData;
100 }
101}
102
103} // namespace ns3
static Ptr< T > Find(std::string path)
Given a name path string, look to see if there's an object in the system with that associated to it.
Definition names.h:443
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:825
Base class for probes.
Definition probe.h:30
bool IsEnabled() const override
Definition probe.cc:54
Smart pointer class similar to boost::intrusive_ptr.
a unique identifier for an interface.
Definition type-id.h:48
TypeId SetParent(TypeId tid)
Set the parent TypeId.
Definition type-id.cc:1001
This class is designed to probe an underlying ns3 TraceSource exporting an uint8_t.
uint8_t GetValue() const
void SetValue(uint8_t value)
static void SetValueByPath(std::string path, uint8_t value)
Set a probe value by its name in the Config system.
static TypeId GetTypeId()
Get the type ID.
void TraceSink(uint8_t oldData, uint8_t newData)
Method to connect to an underlying ns3::TraceSource of type uint8_t.
TracedValue< uint8_t > m_output
Output trace source.
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
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:75
void ConnectWithoutContext(std::string path, const CallbackBase &cb)
Definition config.cc:943
#define NS_LOG_COMPONENT_DEFINE(name)
Define a Log component with a specific name.
Definition log.h:191
#define NS_LOG_DEBUG(msg)
Use NS_LOG to output a message of level LOG_DEBUG.
Definition log.h:257
#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:35
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:684