A Discrete-Event Network Simulator
API
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
ns3::WifiMode Class Reference
Wifi Models

represent a single transmission modeA WifiMode is implemented by a single integer which is used to lookup in a global array the characteristics of the associated transmission mode. It is thus extremely cheap to keep a WifiMode variable around. More...

#include <wifi-mode.h>

Public Member Functions

 WifiMode ()
 
 WifiMode (std::string name)
 
uint32_t GetBandwidth (void) const
 
enum WifiCodeRate GetCodeRate (void) const
 
uint8_t GetConstellationSize (void) const
 
uint64_t GetDataRate (void) const
 
enum WifiModulationClass GetModulationClass () const
 
uint64_t GetPhyRate (void) const
 
uint32_t GetUid (void) const
 
std::string GetUniqueName (void) const
 
bool IsMandatory (void) const
 

Private Member Functions

 WifiMode (uint32_t uid)
 

Private Attributes

uint32_t m_uid
 

Friends

class WifiModeFactory
 

Detailed Description

represent a single transmission mode

A WifiMode is implemented by a single integer which is used to lookup in a global array the characteristics of the associated transmission mode. It is thus extremely cheap to keep a WifiMode variable around.

Definition at line 88 of file wifi-mode.h.

Constructor & Destructor Documentation

ns3::WifiMode::WifiMode ( )

Create an invalid WifiMode. Calling any method on the instance created will trigger an assert. This is useful to separate the declaration of a WifiMode variable from its initialization.

Definition at line 98 of file wifi-mode.cc.

Member Function Documentation

uint32_t ns3::WifiMode::GetBandwidth ( void  ) const
Returns
the number of Hz used by this signal

Definition at line 45 of file wifi-mode.cc.

Referenced by ns3::WifiPhy::GetPayloadDurationMicroSeconds(), ns3::WifiPhy::GetPlcpHeaderDurationMicroSeconds(), ns3::WifiPhy::GetPlcpHeaderMode(), and ns3::WifiPhy::GetPlcpPreambleDurationMicroSeconds().

enum WifiCodeRate ns3::WifiMode::GetCodeRate ( void  ) const
Returns
the coding rate of this transmission mode

Definition at line 63 of file wifi-mode.cc.

uint8_t ns3::WifiMode::GetConstellationSize ( void  ) const
Returns
the size of the modulation constellation.

Definition at line 69 of file wifi-mode.cc.

uint64_t ns3::WifiMode::GetDataRate ( void  ) const
Returns
the data bit rate of this signal.

Definition at line 57 of file wifi-mode.cc.

Referenced by ns3::MeshWifiInterfaceMac::CheckSupportedRates(), ns3::WifiPhy::GetPayloadDurationMicroSeconds(), ns3::MeshWifiInterfaceMac::GetSupportedRates(), ns3::StaWifiMac::Receive(), ns3::ApWifiMac::Receive(), ns3::MeshWifiInterfaceMac::Receive(), and ns3::YansWifiPhy::SendPacket().

enum WifiModulationClass ns3::WifiMode::GetModulationClass ( ) const
Returns
the Modulation Class (see IEEE 802.11-2007 Section 9.6.1) to which this WifiMode belongs.

Definition at line 93 of file wifi-mode.cc.

Referenced by ns3::WifiRemoteStationManager::GetControlAnswerMode(), ns3::WifiPhy::GetPayloadDurationMicroSeconds(), ns3::WifiPhy::GetPlcpHeaderDurationMicroSeconds(), ns3::WifiPhy::GetPlcpHeaderMode(), and ns3::WifiPhy::GetPlcpPreambleDurationMicroSeconds().

uint64_t ns3::WifiMode::GetPhyRate ( void  ) const
Returns
the physical bit rate of this signal.

If a transmission mode uses 1/2 FEC, and if its data rate is 3Mbs, the phy rate is 6Mbs

Definition at line 51 of file wifi-mode.cc.

Referenced by ns3::WifiRemoteStationManager::GetControlAnswerMode().

uint32_t ns3::WifiMode::GetUid ( void  ) const
Returns
the uid associated to this wireless mode.

Each specific wireless mode should have a different uid. For example, the 802.11b 1Mbs and the 802.11b 2Mbs modes should have different uids.

Definition at line 88 of file wifi-mode.cc.

std::string ns3::WifiMode::GetUniqueName ( void  ) const
Returns
a human-readable representation of this WifiMode instance.

Definition at line 75 of file wifi-mode.cc.

bool ns3::WifiMode::IsMandatory ( void  ) const
Returns
true if this mode is a mandatory mode, false otherwise.

Definition at line 82 of file wifi-mode.cc.

Referenced by ns3::WifiRemoteStationManager::GetControlAnswerMode().

The documentation for this class was generated from the following files: