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