A Discrete-Event Network Simulator
API
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 
21 #ifndef PROBE_H
22 #define PROBE_H
23 
24 #include "data-collection-object.h"
25 
26 #include "ns3/nstime.h"
27 
28 namespace ns3
29 {
30 
41 {
42  public:
47  static TypeId GetTypeId();
48  Probe();
49  ~Probe() override;
50 
54  bool IsEnabled() const override;
55 
63  virtual bool ConnectByObject(std::string traceSource, Ptr<Object> obj) = 0;
64 
73  virtual void ConnectByPath(std::string path) = 0;
74 
75  protected:
78 
81 };
82 
83 } // namespace ns3
84 
85 #endif // PROBE_H
Base class for data collection framework objects.
Base class for probes.
Definition: probe.h:41
Time m_start
Time when logging starts.
Definition: probe.h:77
static TypeId GetTypeId()
Get the type ID.
Definition: probe.cc:35
bool IsEnabled() const override
Definition: probe.cc:65
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)=0
connect to a trace source attribute provided by a given object
Time m_stop
Time when logging stops.
Definition: probe.h:80
~Probe() override
Definition: probe.cc:59
virtual void ConnectByPath(std::string path)=0
connect to a trace source provided by a config path
Probe()
Definition: probe.cc:54
Simulation virtual time values and global simulation resolution.
Definition: nstime.h:105
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.