Classes | Static Public Member Functions | Friends

ns3::WifiModeFactory Class Reference

create WifiMode class instances and keep track of them. More...

#include <wifi-mode.h>

List of all members.

Classes

struct  WifiModeItem

Static Public Member Functions

static WifiMode CreateWifiMode (std::string uniqueName, enum WifiModulationClass modClass, bool isMandatory, uint32_t bandwidth, uint32_t dataRate, enum WifiCodeRate codingRate, uint8_t constellationSize)

Friends

class WifiMode
std::istream & operator>> (std::istream &is, WifiMode &mode)

Detailed Description

create WifiMode class instances and keep track of them.

This factory ensures that each WifiMode created has a unique name and assigns to each of them a unique integer.


Member Function Documentation

static WifiMode ns3::WifiModeFactory::CreateWifiMode ( std::string  uniqueName,
enum WifiModulationClass  modClass,
bool  isMandatory,
uint32_t  bandwidth,
uint32_t  dataRate,
enum WifiCodeRate  codingRate,
uint8_t  constellationSize 
) [static]
Parameters:
uniqueNamethe name of the associated WifiMode. This name must be unique accross _all_ instances.
modClassthe class of modulation
isMandatorytrue if this WifiMode is mandatory, false otherwise.
bandwidththe bandwidth (Hz) of the signal generated when the associated WifiMode is used.
dataRatethe rate (bits/second) at which the user data is transmitted
codingRateif convolutional coding is used for this rate then this parameter specifies the convolutional coding rate used. If there is no explicit convolutional coding step (e.g., for DSSS rates) then the caller should set this parameter to WIFI_CODE_RATE_UNCODED.
constellationSizethe order of the constellation used.

Create a WifiMode.


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