A Discrete-Event Network Simulator
API
double-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 DOUBLE_PROBE_H
25#define DOUBLE_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
34namespace ns3 {
35
47class DoubleProbe : public Probe
48{
49public:
54 static TypeId GetTypeId ();
55 DoubleProbe ();
56 virtual ~DoubleProbe ();
57
61 double GetValue (void) const;
62
66 void SetValue (double value);
67
74 static void SetValueByPath (std::string path, double value);
75
83 virtual bool ConnectByObject (std::string traceSource, Ptr<Object> obj);
84
93 virtual void ConnectByPath (std::string path);
94
95private:
102 void TraceSink (double oldData, double newData);
103
105};
106
107} // namespace ns3
108
109#endif // DOUBLE_PROBE_H
This class is designed to probe an underlying ns3 TraceSource exporting a double.
Definition: double-probe.h:48
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Definition: double-probe.cc:95
static void SetValueByPath(std::string path, double value)
Set a probe value by its name in the Config system.
Definition: double-probe.cc:77
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Definition: double-probe.cc:86
void SetValue(double value)
Definition: double-probe.cc:70
void TraceSink(double oldData, double newData)
Method to connect to an underlying ns3::TraceSource of type double.
virtual ~DoubleProbe()
Definition: double-probe.cc:58
double GetValue(void) const
Definition: double-probe.cc:64
static TypeId GetTypeId()
Get the type ID.
Definition: double-probe.cc:38
TracedValue< double > m_output
Output trace source.
Definition: double-probe.h:104
Base class for probes.
Definition: probe.h:40
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.