A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
boolean-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 BOOL_PROBE_H
24
#define BOOL_PROBE_H
25
26
#include "
probe.h
"
27
28
#include "ns3/boolean.h"
29
#include "ns3/callback.h"
30
#include "ns3/object.h"
31
#include "ns3/simulator.h"
32
#include "ns3/traced-value.h"
33
34
namespace
ns3
35
{
36
48
class
BooleanProbe
:
public
Probe
49
{
50
public
:
55
static
TypeId
GetTypeId
();
56
BooleanProbe
();
57
~BooleanProbe
()
override
;
58
62
bool
GetValue
()
const
;
63
67
void
SetValue
(
bool
value);
68
75
static
void
SetValueByPath
(std::string path,
bool
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
(
bool
oldData,
bool
newData);
104
105
TracedValue<bool>
m_output
;
106
};
107
108
}
// namespace ns3
109
110
#endif
// BOOL_PROBE_H
ns3::BooleanProbe
This class is designed to probe an underlying ns3 TraceSource exporting a bool.
Definition:
boolean-probe.h:49
ns3::BooleanProbe::SetValueByPath
static void SetValueByPath(std::string path, bool value)
Set a probe value by its name in the Config system.
Definition:
boolean-probe.cc:78
ns3::BooleanProbe::m_output
TracedValue< bool > m_output
Output trace source.
Definition:
boolean-probe.h:105
ns3::BooleanProbe::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
boolean-probe.cc:39
ns3::BooleanProbe::BooleanProbe
BooleanProbe()
Definition:
boolean-probe.cc:52
ns3::BooleanProbe::TraceSink
void TraceSink(bool oldData, bool newData)
Method to connect to an underlying ns3::TraceSource of type bool.
Definition:
boolean-probe.cc:106
ns3::BooleanProbe::SetValue
void SetValue(bool value)
Definition:
boolean-probe.cc:71
ns3::BooleanProbe::ConnectByPath
void ConnectByPath(std::string path) override
connect to a trace source provided by a config path
Definition:
boolean-probe.cc:98
ns3::BooleanProbe::GetValue
bool GetValue() const
Definition:
boolean-probe.cc:64
ns3::BooleanProbe::ConnectByObject
bool ConnectByObject(std::string traceSource, Ptr< Object > obj) override
connect to a trace source attribute provided by a given object
Definition:
boolean-probe.cc:87
ns3::BooleanProbe::~BooleanProbe
~BooleanProbe() override
Definition:
boolean-probe.cc:58
ns3::Probe
Base class for probes.
Definition:
probe.h:41
ns3::Ptr< Object >
ns3::TracedValue< bool >
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
probe.h
src
stats
model
boolean-probe.h
Generated on Sun Mar 3 2024 17:11:08 for ns-3 by
1.9.1