A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
Loading...
Searching...
No Matches
uinteger-8-probe.h
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
#ifndef UINTEGER_8_PROBE_H
24
#define UINTEGER_8_PROBE_H
25
26
#include "
probe.h
"
27
28
#include "ns3/callback.h"
29
#include "ns3/traced-value.h"
30
31
namespace
ns3
32
{
33
34
/**
35
* \ingroup probes
36
*
37
* This class is designed to probe an underlying ns3 TraceSource exporting
38
* an uint8_t. This probe exports a trace source "Output" of type uint8_t.
39
* The Output trace source emits a value when either the trace source
40
* emits a new value, or when SetValue () is called.
41
*
42
* The current value of the probe can be polled with the GetValue () method.
43
*/
44
class
Uinteger8Probe
:
public
Probe
45
{
46
public
:
47
/**
48
* \brief Get the type ID.
49
* \return the object TypeId
50
*/
51
static
TypeId
GetTypeId
();
52
Uinteger8Probe
();
53
~Uinteger8Probe
()
override
;
54
55
/**
56
* \return the most recent value
57
*/
58
uint8_t
GetValue
()
const
;
59
60
/**
61
* \param value set the traced uint8_t to a new value
62
*/
63
void
SetValue
(uint8_t value);
64
65
/**
66
* \brief Set a probe value by its name in the Config system
67
*
68
* \param path Config path to access the probe
69
* \param value set the traced uint8_t to a new value
70
*/
71
static
void
SetValueByPath
(std::string path, uint8_t value);
72
73
/**
74
* \brief connect to a trace source attribute provided by a given object
75
*
76
* \param traceSource the name of the attribute TraceSource to connect to
77
* \param obj ns3::Object to connect to
78
* \return true if the trace source was successfully connected
79
*/
80
bool
ConnectByObject
(std::string traceSource,
Ptr<Object>
obj)
override
;
81
82
/**
83
* \brief connect to a trace source provided by a config path
84
*
85
* \param path Config path to bind to
86
*
87
* Note, if an invalid path is provided, the probe will not be connected
88
* to anything.
89
*/
90
void
ConnectByPath
(std::string path)
override
;
91
92
private
:
93
/**
94
* \brief Method to connect to an underlying ns3::TraceSource of type uint8_t
95
*
96
* \param oldData previous value of the uint8_t
97
* \param newData new value of the uint8_t
98
*/
99
void
TraceSink
(uint8_t oldData, uint8_t newData);
100
101
TracedValue<uint8_t>
m_output
;
//!< Output trace source.
102
};
103
104
}
// namespace ns3
105
106
#endif
// UINTEGER_8_PROBE_H
ns3::Probe
Base class for probes.
Definition:
probe.h:41
ns3::Ptr
Smart pointer class similar to boost::intrusive_ptr.
Definition:
ptr.h:77
ns3::TracedValue
Trace classes with value semantics.
Definition:
traced-value.h:116
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
ns3::Uinteger8Probe
This class is designed to probe an underlying ns3 TraceSource exporting an uint8_t.
Definition:
uinteger-8-probe.h:45
ns3::Uinteger8Probe::~Uinteger8Probe
~Uinteger8Probe() override
Definition:
uinteger-8-probe.cc:57
ns3::Uinteger8Probe::GetValue
uint8_t GetValue() const
Definition:
uinteger-8-probe.cc:63
ns3::Uinteger8Probe::SetValue
void SetValue(uint8_t value)
Definition:
uinteger-8-probe.cc:70
ns3::Uinteger8Probe::Uinteger8Probe
Uinteger8Probe()
Definition:
uinteger-8-probe.cc:51
ns3::Uinteger8Probe::SetValueByPath
static void SetValueByPath(std::string path, uint8_t value)
Set a probe value by its name in the Config system.
Definition:
uinteger-8-probe.cc:77
ns3::Uinteger8Probe::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
uinteger-8-probe.cc:38
ns3::Uinteger8Probe::TraceSink
void TraceSink(uint8_t oldData, uint8_t newData)
Method to connect to an underlying ns3::TraceSource of type uint8_t.
Definition:
uinteger-8-probe.cc:105
ns3::Uinteger8Probe::m_output
TracedValue< uint8_t > m_output
Output trace source.
Definition:
uinteger-8-probe.h:101
ns3::Uinteger8Probe::ConnectByPath
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
Definition:
uinteger-8-probe.cc:97
ns3::Uinteger8Probe::ConnectByObject
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
Definition:
uinteger-8-probe.cc:86
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
probe.h
src
stats
model
uinteger-8-probe.h
Generated on Tue May 28 2024 23:39:30 for ns-3 by
1.9.6