A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
boolean-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 BOOL_PROBE_H
25
#define BOOL_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
34
namespace
ns3
{
35
47
class
BooleanProbe
:
public
Probe
48
{
49
public
:
54
static
TypeId
GetTypeId
();
55
BooleanProbe
();
56
virtual
~BooleanProbe
();
57
61
bool
GetValue
(
void
)
const
;
62
66
void
SetValue
(
bool
value);
67
74
static
void
SetValueByPath
(std::string path,
bool
value);
75
83
virtual
bool
ConnectByObject
(std::string traceSource,
Ptr<Object>
obj);
84
93
virtual
void
ConnectByPath
(std::string path);
94
95
private
:
102
void
TraceSink
(
bool
oldData,
bool
newData);
103
104
TracedValue<bool>
m_output
;
105
};
106
107
}
// namespace ns3
108
109
#endif
// BOOL_PROBE_H
ns3::BooleanProbe
This class is designed to probe an underlying ns3 TraceSource exporting a bool.
Definition:
boolean-probe.h:48
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:77
ns3::BooleanProbe::m_output
TracedValue< bool > m_output
Output trace source.
Definition:
boolean-probe.h:104
ns3::BooleanProbe::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
boolean-probe.cc:38
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:103
ns3::BooleanProbe::SetValue
void SetValue(bool value)
Definition:
boolean-probe.cc:70
ns3::BooleanProbe::~BooleanProbe
virtual ~BooleanProbe()
Definition:
boolean-probe.cc:58
ns3::BooleanProbe::GetValue
bool GetValue(void) const
Definition:
boolean-probe.cc:64
ns3::BooleanProbe::ConnectByObject
virtual bool ConnectByObject(std::string traceSource, Ptr< Object > obj)
connect to a trace source attribute provided by a given object
Definition:
boolean-probe.cc:86
ns3::BooleanProbe::ConnectByPath
virtual void ConnectByPath(std::string path)
connect to a trace source provided by a config path
Definition:
boolean-probe.cc:95
ns3::Probe
Base class for probes.
Definition:
probe.h:40
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.
src
stats
model
boolean-probe.h
Generated on Tue Feb 6 2024 19:21:27 for ns-3 by
1.9.1