A Discrete-Event Network Simulator
API
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 "ns3/boolean.h"
27#include "ns3/callback.h"
28#include "ns3/nstime.h"
29#include "ns3/object.h"
30#include "ns3/probe.h"
31#include "ns3/simulator.h"
32#include "ns3/traced-value.h"
33
34namespace ns3
35{
36
48class TimeProbe : public Probe
49{
50 public:
55 static TypeId GetTypeId();
56 TimeProbe();
57 ~TimeProbe() override;
58
62 double GetValue() const;
63
67 void SetValue(Time value);
68
75 static void SetValueByPath(std::string path, Time value);
76
84 bool ConnectByObject(std::string traceSource, Ptr<Object> obj) override;
85
94 void ConnectByPath(std::string path) override;
95
96 private:
103 void TraceSink(Time oldData, Time newData);
104
106};
107
108} // namespace ns3
109
110#endif // TIME_PROBE_H
Base class for probes.
Definition: probe.h:40
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
This class is designed to probe an underlying ns3 TraceSource exporting an ns3::Time.
Definition: time-probe.h:49
static TypeId GetTypeId()
Get the type ID.
Definition: time-probe.cc:40
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
void SetValue(Time value)
Definition: time-probe.cc:72
double GetValue() const
Definition: time-probe.cc:65
TracedValue< double > m_output
Output trace source.
Definition: time-probe.h:105
~TimeProbe() override
Definition: time-probe.cc:59
void TraceSink(Time oldData, Time newData)
Method to connect to an underlying ns3::TraceSource of type Time.
Definition: time-probe.cc:107
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
Definition: time-probe.cc:99
static void SetValueByPath(std::string path, Time value)
Set a probe value by its name in the Config system.
Definition: time-probe.cc:79
a unique identifier for an interface.
Definition: type-id.h:60
Every class exported by the ns3 library is enclosed in the ns3 namespace.
value
Definition: second.py:41