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