A Discrete-Event Network Simulator
Home
Tutorials ▼
English
Documentation ▼
Installation
Manual
Models
Contributing
Wiki
Development ▼
API Docs
Issue Tracker
Merge Requests
API
obss-pd-algorithm.h
Go to the documentation of this file.
1
/*
2
* Copyright (c) 2018 University of Washington
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
* Author: Sébastien Deronne <sebastien.deronne@gmail.com>
18
*/
19
20
#ifndef OBSS_PD_ALGORITHM_H
21
#define OBSS_PD_ALGORITHM_H
22
23
#include "
he-configuration.h
"
24
25
#include "ns3/object.h"
26
#include "ns3/traced-callback.h"
27
28
namespace
ns3
29
{
30
31
struct
HeSigAParameters;
32
33
class
WifiNetDevice;
34
46
class
ObssPdAlgorithm
:
public
Object
47
{
48
public
:
53
static
TypeId
GetTypeId
();
54
60
virtual
void
ConnectWifiNetDevice
(
const
Ptr<WifiNetDevice>
device);
61
66
void
ResetPhy
(
HeSigAParameters
params
);
67
73
virtual
void
ReceiveHeSigA
(
HeSigAParameters
params
) = 0;
74
84
typedef
void (*
ResetTracedCallback
)(uint8_t bssColor,
85
double
rssiDbm,
86
bool
powerRestricted,
87
double
txPowerMaxDbmSiso,
88
double
txPowerMaxDbmMimo);
89
93
void
SetObssPdLevel
(
double
level);
97
double
GetObssPdLevel
()
const
;
98
99
protected
:
100
void
DoDispose
()
override
;
101
102
Ptr<WifiNetDevice>
m_device
;
103
104
private
:
105
double
m_obssPdLevel
;
106
double
m_obssPdLevelMin
;
107
double
m_obssPdLevelMax
;
108
double
m_txPowerRefSiso
;
109
double
m_txPowerRefMimo
;
110
114
TracedCallback<uint8_t, double, bool, double, double>
m_resetEvent
;
115
};
116
117
}
// namespace ns3
118
119
#endif
/* OBSS_PD_ALGORITHM_H */
ns3::Object
A base class which provides memory management and object aggregation.
Definition:
object.h:89
ns3::ObssPdAlgorithm
OBSS PD algorithm interface.
Definition:
obss-pd-algorithm.h:47
ns3::ObssPdAlgorithm::DoDispose
void DoDispose() override
Destructor implementation.
Definition:
obss-pd-algorithm.cc:76
ns3::ObssPdAlgorithm::ResetPhy
void ResetPhy(HeSigAParameters params)
Reset PHY to IDLE.
Definition:
obss-pd-algorithm.cc:100
ns3::ObssPdAlgorithm::SetObssPdLevel
void SetObssPdLevel(double level)
Definition:
obss-pd-algorithm.cc:124
ns3::ObssPdAlgorithm::ReceiveHeSigA
virtual void ReceiveHeSigA(HeSigAParameters params)=0
ns3::ObssPdAlgorithm::m_obssPdLevelMax
double m_obssPdLevelMax
Maximum OBSS PD level (dBm)
Definition:
obss-pd-algorithm.h:107
ns3::ObssPdAlgorithm::GetTypeId
static TypeId GetTypeId()
Get the type ID.
Definition:
obss-pd-algorithm.cc:36
ns3::ObssPdAlgorithm::m_txPowerRefSiso
double m_txPowerRefSiso
SISO reference TX power level (dBm)
Definition:
obss-pd-algorithm.h:108
ns3::ObssPdAlgorithm::m_device
Ptr< WifiNetDevice > m_device
Pointer to the WifiNetDevice.
Definition:
obss-pd-algorithm.h:102
ns3::ObssPdAlgorithm::m_obssPdLevel
double m_obssPdLevel
Current OBSS PD level (dBm)
Definition:
obss-pd-algorithm.h:105
ns3::ObssPdAlgorithm::m_obssPdLevelMin
double m_obssPdLevelMin
Minimum OBSS PD level (dBm)
Definition:
obss-pd-algorithm.h:106
ns3::ObssPdAlgorithm::m_txPowerRefMimo
double m_txPowerRefMimo
MIMO reference TX power level (dBm)
Definition:
obss-pd-algorithm.h:109
ns3::ObssPdAlgorithm::ResetTracedCallback
void(* ResetTracedCallback)(uint8_t bssColor, double rssiDbm, bool powerRestricted, double txPowerMaxDbmSiso, double txPowerMaxDbmMimo)
TracedCallback signature for OBSS_PD reset events.
Definition:
obss-pd-algorithm.h:84
ns3::ObssPdAlgorithm::ConnectWifiNetDevice
virtual void ConnectWifiNetDevice(const Ptr< WifiNetDevice > device)
Connect the WifiNetDevice and setup eventual callbacks.
Definition:
obss-pd-algorithm.cc:83
ns3::ObssPdAlgorithm::m_resetEvent
TracedCallback< uint8_t, double, bool, double, double > m_resetEvent
TracedCallback signature for PHY reset events.
Definition:
obss-pd-algorithm.h:114
ns3::ObssPdAlgorithm::GetObssPdLevel
double GetObssPdLevel() const
Definition:
obss-pd-algorithm.cc:131
ns3::Ptr< WifiNetDevice >
ns3::TracedCallback< uint8_t, double, bool, double, double >
ns3::TypeId
a unique identifier for an interface.
Definition:
type-id.h:59
he-configuration.h
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
two-ray-to-three-gpp-ch-calibration.params
params
Fit Fluctuating Two Ray model to the 3GPP TR 38.901 using the Anderson-Darling goodness-of-fit ##.
Definition:
two-ray-to-three-gpp-ch-calibration.py:514
ns3::HeSigAParameters
Parameters for received HE-SIG-A for OBSS_PD based SR.
Definition:
he-phy.h:54
src
wifi
model
he
obss-pd-algorithm.h
Generated on Sun Mar 3 2024 17:11:10 for ns-3 by
1.9.1