Public Member Functions | Friends

ns3::WifiMode Class Reference

represent a single transmission mode More...

#include <wifi-mode.h>

List of all members.

Public Member Functions

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

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.


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.


Member Function Documentation

uint32_t ns3::WifiMode::GetBandwidth ( void   )  const
Returns:
the number of Hz used by this signal
enum WifiCodeRate ns3::WifiMode::GetCodeRate ( void   )  const
Returns:
the coding rate of this transmission mode
uint8_t ns3::WifiMode::GetConstellationSize ( void   )  const
Returns:
the size of the modulation constellation.
uint32_t ns3::WifiMode::GetDataRate ( void   )  const
Returns:
the data bit rate of this signal.
enum WifiModulationClass ns3::WifiMode::GetModulationClass (  )  const
Returns:
the Modulation Class (see IEEE 802.11-2007 Section 9.6.1) to which this WifiMode belongs.
uint32_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

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.

std::string ns3::WifiMode::GetUniqueName ( void   )  const
Returns:
a human-readable representation of this WifiMode instance.
bool ns3::WifiMode::IsMandatory ( void   )  const
Returns:
true if this mode is a mandatory mode, false otherwise.

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