A Discrete-Event Network Simulator
API
obss-pd-algorithm.h
Go to the documentation of this file.
1 /* -*- Mode: C++; c-file-style: "gnu"; indent-tabs-mode:nil; -*- */
2 /*
3  * Copyright (c) 2018 University of Washington
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  * Author: S├ębastien Deronne <sebastien.deronne@gmail.com>
19  */
20 
21 #ifndef OBSS_PD_ALGORITHM_H
22 #define OBSS_PD_ALGORITHM_H
23 
24 #include "ns3/object.h"
25 #include "ns3/traced-callback.h"
26 #include "he-configuration.h"
27 
28 namespace ns3 {
29 
30 struct HeSigAParameters;
31 
32 class WifiNetDevice;
33 
45 class ObssPdAlgorithm : public Object
46 {
47 public:
52  static TypeId GetTypeId (void);
53 
59  virtual void ConnectWifiNetDevice (const Ptr<WifiNetDevice> device);
60 
65  void ResetPhy (HeSigAParameters params);
66 
72  virtual void ReceiveHeSigA (HeSigAParameters params) = 0;
73 
83  typedef void (* ResetTracedCallback)(uint8_t bssColor, double rssiDbm, bool powerRestricted, double txPowerMaxDbmSiso, double txPowerMaxDbmMimo);
84 
85 
86 protected:
87  void DoDispose (void) override;
88 
90  double m_obssPdLevel;
91 
92 
93 private:
98 
103 };
104 
105 } //namespace ns3
106 
107 #endif /* OBSS_PD_ALGORITHM_H */
ns3::TypeId
a unique identifier for an interface.
Definition: type-id.h:59
ns3::ObssPdAlgorithm::m_txPowerRefMimo
double m_txPowerRefMimo
MIMO reference TX power level (dBm)
Definition: obss-pd-algorithm.h:97
ns3
Every class exported by the ns3 library is enclosed in the ns3 namespace.
ns3::ObssPdAlgorithm::DoDispose
void DoDispose(void) override
Destructor implementation.
Definition: obss-pd-algorithm.cc:73
ns3::ObssPdAlgorithm::m_obssPdLevel
double m_obssPdLevel
Current OBSS PD level (dBm)
Definition: obss-pd-algorithm.h:90
ns3::ObssPdAlgorithm::m_device
Ptr< WifiNetDevice > m_device
Pointer to the WifiNetDevice.
Definition: obss-pd-algorithm.h:89
ns3::Ptr< WifiNetDevice >
ns3::Object
A base class which provides memory management and object aggregation.
Definition: object.h:88
ns3::ObssPdAlgorithm::m_txPowerRefSiso
double m_txPowerRefSiso
SISO reference TX power level (dBm)
Definition: obss-pd-algorithm.h:96
ns3::ObssPdAlgorithm::ConnectWifiNetDevice
virtual void ConnectWifiNetDevice(const Ptr< WifiNetDevice > device)
Connect the WifiNetDevice and setup eventual callbacks.
Definition: obss-pd-algorithm.cc:80
ns3::ObssPdAlgorithm
OBSS PD algorithm interface.
Definition: obss-pd-algorithm.h:46
ns3::ObssPdAlgorithm::m_resetEvent
TracedCallback< uint8_t, double, bool, double, double > m_resetEvent
TracedCallback signature for PHY reset events.
Definition: obss-pd-algorithm.h:102
ns3::ObssPdAlgorithm::ReceiveHeSigA
virtual void ReceiveHeSigA(HeSigAParameters params)=0
ns3::TracedCallback< uint8_t, double, bool, double, double >
he-configuration.h
ns3::ObssPdAlgorithm::GetTypeId
static TypeId GetTypeId(void)
Get the type ID.
Definition: obss-pd-algorithm.cc:35
ns3::ObssPdAlgorithm::m_obssPdLevelMax
double m_obssPdLevelMax
Maximum OBSS PD level (dBm)
Definition: obss-pd-algorithm.h:95
ns3::HeSigAParameters
Parameters for received HE-SIG-A for OBSS_PD based SR.
Definition: he-phy.h:47
ns3::ObssPdAlgorithm::m_obssPdLevelMin
double m_obssPdLevelMin
Minimum OBSS PD level (dBm)
Definition: obss-pd-algorithm.h:94
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:83
ns3::ObssPdAlgorithm::ResetPhy
void ResetPhy(HeSigAParameters params)
Reset PHY to IDLE.
Definition: obss-pd-algorithm.cc:87