A Discrete-Event Network Simulator
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 
67 
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 
103 
104  private:
105  double m_obssPdLevel;
110 
115 };
116 
117 } // namespace ns3
118 
119 #endif /* OBSS_PD_ALGORITHM_H */
A base class which provides memory management and object aggregation.
Definition: object.h:89
OBSS PD algorithm interface.
void DoDispose() override
Destructor implementation.
void ResetPhy(HeSigAParameters params)
Reset PHY to IDLE.
void SetObssPdLevel(double level)
virtual void ReceiveHeSigA(HeSigAParameters params)=0
double m_obssPdLevelMax
Maximum OBSS PD level (dBm)
static TypeId GetTypeId()
Get the type ID.
double m_txPowerRefSiso
SISO reference TX power level (dBm)
Ptr< WifiNetDevice > m_device
Pointer to the WifiNetDevice.
double m_obssPdLevel
Current OBSS PD level (dBm)
double m_obssPdLevelMin
Minimum OBSS PD level (dBm)
double m_txPowerRefMimo
MIMO reference TX power level (dBm)
void(* ResetTracedCallback)(uint8_t bssColor, double rssiDbm, bool powerRestricted, double txPowerMaxDbmSiso, double txPowerMaxDbmMimo)
TracedCallback signature for OBSS_PD reset events.
virtual void ConnectWifiNetDevice(const Ptr< WifiNetDevice > device)
Connect the WifiNetDevice and setup eventual callbacks.
TracedCallback< uint8_t, double, bool, double, double > m_resetEvent
TracedCallback signature for PHY reset events.
double GetObssPdLevel() const
a unique identifier for an interface.
Definition: type-id.h:59
Every class exported by the ns3 library is enclosed in the ns3 namespace.
params
Fit Fluctuating Two Ray model to the 3GPP TR 38.901 using the Anderson-Darling goodness-of-fit ##.
Parameters for received HE-SIG-A for OBSS_PD based SR.
Definition: he-phy.h:54