A Discrete-Event Network Simulator
API
time-probe.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2011 Bucknell University
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation;
8 *
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
13 *
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 *
18 * Authors: L. Felipe Perrone (perrone@bucknell.edu)
19 * Tiago G. Rodrigues (tgr002@bucknell.edu)
20 *
21 * Modified by: Mitch Watrous (watrous@u.washington.edu)
22 */
23
24#ifndef TIME_PROBE_H
25#define TIME_PROBE_H
26
27#include "ns3/probe.h"
28#include "ns3/object.h"
29#include "ns3/callback.h"
30#include "ns3/boolean.h"
31#include "ns3/traced-value.h"
32#include "ns3/simulator.h"
33#include "ns3/nstime.h"
34
35namespace ns3 {
36
48class TimeProbe : public Probe
49{
50public:
55 static TypeId GetTypeId ();
56 TimeProbe ();
57 virtual ~TimeProbe ();
58
62 double GetValue (void) const;
63
67 void SetValue (Time value);
68
75 static void SetValueByPath (std::string path, Time value);
76
84 virtual bool ConnectByObject (std::string traceSource, Ptr<Object> obj);
85
94 virtual void ConnectByPath (std::string path);
95
96private:
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:103
This class is designed to probe an underlying ns3 TraceSource exporting an ns3::Time.
Definition: time-probe.h:49
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Definition: time-probe.cc:87
static TypeId GetTypeId()
Get the type ID.
Definition: time-probe.cc:39
virtual ~TimeProbe()
Definition: time-probe.cc:59
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Definition: time-probe.cc:96
void SetValue(Time value)
Definition: time-probe.cc:71
TracedValue< double > m_output
Output trace source.
Definition: time-probe.h:105
void TraceSink(Time oldData, Time newData)
Method to connect to an underlying ns3::TraceSource of type Time.
Definition: time-probe.cc:104
double GetValue(void) const
Definition: time-probe.cc:65
static void SetValueByPath(std::string path, Time value)
Set a probe value by its name in the Config system.
Definition: time-probe.cc:78
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.