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 HePreambleParameters;
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 (HePreambleParameters params);
66 
72  virtual void ReceiveHeSig (HePreambleParameters params) = 0;
73 
83  typedef void (* ResetTracedCallback)(uint8_t bssColor, double rssiDbm, bool powerRestricted, double txPowerMaxDbmSiso, double txPowerMaxDbmMimo);
84 
85 protected:
86  virtual void DoDispose (void);
87 
89  double m_obssPdLevel;
90 
91 
92 private:
97 
102 };
103 
104 } //namespace ns3
105 
106 #endif /* OBSS_PD_ALGORITHM_H */
double m_txPowerRefSiso
SISO reference TX power level (dBm)
double m_txPowerRefMimo
MIMO reference TX power level (dBm)
OBSS PD algorithm interfaceThis object provides the interface for all OBSS_PD algorithms and is desig...
static TypeId GetTypeId(void)
Get the type ID.
double m_obssPdLevelMin
Minimum OBSS PD level (dBm)
double m_obssPdLevelMax
Maximum OBSS PD level (dBm)
void(* ResetTracedCallback)(uint8_t bssColor, double rssiDbm, bool powerRestricted, double txPowerMaxDbmSiso, double txPowerMaxDbmMimo)
TracedCallback signature for OBSS_PD reset events.
double m_obssPdLevel
Current OBSS PD level (dBm)
virtual void ConnectWifiNetDevice(const Ptr< WifiNetDevice > device)
Connect the WifiNetDevice and setup eventual callbacks.
Ptr< WifiNetDevice > m_device
Pointer to the WifiNetDevice.
Every class exported by the ns3 library is enclosed in the ns3 namespace.
virtual void DoDispose(void)
Destructor implementation.
void ResetPhy(HePreambleParameters params)
Reset PHY to IDLE.
A base class which provides memory management and object aggregation.
Definition: object.h:87
virtual void ReceiveHeSig(HePreambleParameters params)=0
TracedCallback< uint8_t, double, bool, double, double > m_resetEvent
TracedCallback signature for PHY reset events.
a unique identifier for an interface.
Definition: type-id.h:58
Parameters for receive HE preamble.
Definition: wifi-phy.h:130