A Discrete-Event Network Simulator
API
uinteger-16-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 UINTEGER_16_PROBE_H
24 #define UINTEGER_16_PROBE_H
25 
26 #include "probe.h"
27 
28 #include "ns3/callback.h"
29 #include "ns3/traced-value.h"
30 
31 namespace ns3
32 {
33 
44 class Uinteger16Probe : public Probe
45 {
46  public:
51  static TypeId GetTypeId();
53  ~Uinteger16Probe() override;
54 
58  uint16_t GetValue() const;
59 
63  void SetValue(uint16_t value);
64 
71  static void SetValueByPath(std::string path, uint16_t value);
72 
80  bool ConnectByObject(std::string traceSource, Ptr<Object> obj) override;
81 
90  void ConnectByPath(std::string path) override;
91 
92  private:
99  void TraceSink(uint16_t oldData, uint16_t newData);
100 
102 };
103 
104 } // namespace ns3
105 
106 #endif // UINTEGER_16_PROBE_H
Base class for probes.
Definition: probe.h:41
a unique identifier for an interface.
Definition: type-id.h:59
This class is designed to probe an underlying ns3 TraceSource exporting an uint16_t.
void TraceSink(uint16_t oldData, uint16_t newData)
Method to connect to an underlying ns3::TraceSource of type uint16_t.
TracedValue< uint16_t > m_output
Output trace source.
static void SetValueByPath(std::string path, uint16_t value)
Set a probe value by its name in the Config system.
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
void SetValue(uint16_t value)
static TypeId GetTypeId()
Get the type ID.
uint16_t GetValue() const
Every class exported by the ns3 library is enclosed in the ns3 namespace.