ns3::YansWifiPhy Class Reference

802.11 PHY layer model More...

#include <yans-wifi-phy.h>

Inheritance diagram for ns3::YansWifiPhy:

Inheritance graph
[legend]
Collaboration diagram for ns3::YansWifiPhy:

Collaboration graph
[legend]

List of all members.

Public Member Functions

virtual uint32_t GetNTxPower (void) const
virtual void SetReceiveOkCallback (WifiPhy::SyncOkCallback callback)
virtual void SetReceiveErrorCallback (WifiPhy::SyncErrorCallback callback)
virtual void SendPacket (Ptr< const Packet > packet, WifiMode mode, enum WifiPreamble preamble, uint8_t txPowerLevel)
virtual void RegisterListener (WifiPhyListener *listener)
virtual bool IsStateCcaBusy (void)
virtual bool IsStateIdle (void)
virtual bool IsStateBusy (void)
virtual bool IsStateSync (void)
virtual bool IsStateTx (void)
virtual Time GetStateDuration (void)
virtual Time GetDelayUntilIdle (void)
virtual Time CalculateTxDuration (uint32_t size, WifiMode payloadMode, enum WifiPreamble preamble) const
virtual uint32_t GetNModes (void) const
virtual WifiMode GetMode (uint32_t mode) const
virtual double CalculateSnr (WifiMode txMode, double ber) const

Static Public Member Functions

static TypeId GetTypeId (void)
 This method returns the TypeId associated to ns3::YansWifiPhy.

Private Member Functions

virtual void DoDispose (void)

Detailed Description

802.11 PHY layer model

This PHY implements a model of 802.11a. The model implemented here is based on the model described in "Yet Another Network Simulator", (http://cutebugs.net/files/wns2-yans.pdf).

This PHY model depends on a channel loss and delay model as provided by the ns3::PropagationLossModel and ns3::PropagationDelayModel classes, both of which are members of the ns3::YansWifiChannel class.

Member Function Documentation

virtual double ns3::YansWifiPhy::CalculateSnr ( WifiMode  txMode,
double  ber 
) const [virtual]

Parameters:
txMode the transmission mode
ber the probability of bit error rate
Returns:
the minimum snr which is required to achieve the requested ber for the specified transmission mode. (W/W)

Implements ns3::WifiPhy.

virtual Time ns3::YansWifiPhy::CalculateTxDuration ( uint32_t  size,
WifiMode  payloadMode,
enum WifiPreamble  preamble 
) const [virtual]

Parameters:
size the number of bytes in the packet to send
payloadMode the transmission mode to use for this packet
preamble the type of preamble to use for this packet.
Returns:
the total amount of time this PHY will stay busy for the transmission of these bytes.

Implements ns3::WifiPhy.

virtual void ns3::YansWifiPhy::DoDispose ( void   )  [private, virtual]

This method is called by Object::Dispose or by the object's destructor, whichever comes first.

Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e., for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose method.

Reimplemented from ns3::Object.

virtual Time ns3::YansWifiPhy::GetDelayUntilIdle ( void   )  [virtual]

Returns:
the predicted delay until this PHY can become WifiPhy::IDLE.
The PHY will never become WifiPhy::IDLE _before_ the delay returned by this method but it could become really idle later.

Implements ns3::WifiPhy.

virtual WifiMode ns3::YansWifiPhy::GetMode ( uint32_t  mode  )  const [virtual]

Parameters:
mode index in array of supported modes
Returns:
the mode whose index is specified.

Implements ns3::WifiPhy.

virtual uint32_t ns3::YansWifiPhy::GetNModes ( void   )  const [virtual]

Returns:
the number of transmission modes supported by this PHY.

Implements ns3::WifiPhy.

virtual uint32_t ns3::YansWifiPhy::GetNTxPower ( void   )  const [virtual]

Returns:
the number of tx power levels available for this PHY.

Implements ns3::WifiPhy.

virtual Time ns3::YansWifiPhy::GetStateDuration ( void   )  [virtual]

Returns:
the amount of time since the current state has started.

Implements ns3::WifiPhy.

static TypeId ns3::YansWifiPhy::GetTypeId ( void   )  [static]

This method returns the TypeId associated to ns3::YansWifiPhy.

This object is accessible through the following paths with Config::Set and Config::Connect:

  • /NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/$ns3::YansWifiPhy
Attributes defined for this type:
  • EnergyDetectionThreshold: The energy of a received signal should be higher than this threshold (dbm) to allow the PHY layer to detect the signal.
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: -140
    • Flags: construct write read
  • CcaMode1Threshold: The energy of a received signal should be higher than this threshold (dbm) to allow the PHY layer to declare CCA BUSY state
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: -140
    • Flags: construct write read
  • TxGain: Transmission gain (dB).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: construct write read
  • RxGain: Reception gain (dB).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 1
    • Flags: construct write read
  • TxPowerLevels: Number of transmission power levels available between TxPowerBase and TxPowerEnd included.
  • TxPowerEnd: Maximum available transmission level (dbm).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 16.0206
    • Flags: construct write read
  • TxPowerStart: Minimum available transmission level (dbm).
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 16.0206
    • Flags: construct write read
  • RxNoiseFigure: Loss (dB) in the Signal-to-Noise-Ratio due to non-idealities in the receiver. According to Wikipedia (http://en.wikipedia.org/wiki/Noise_figure), this is "the difference in decibels (dB) between the noise output of the actual receiver to the noise output of an ideal receiver with the same overall gain and bandwidth when the receivers are connected to sources at the standard noise temperature T0 (usually 290 K)". For
    • Set with class: ns3::DoubleValue
    • Underlying type: double -1.79769e+308:1.79769e+308
    • Initial value: 7
    • Flags: construct write read
  • Standard: The standard chosen configures a set of transmission modes and some PHY-specific constants.
    • Set with class: ns3::EnumValue
    • Underlying type: 802.11a|802.11b|holland
    • Initial value: 802.11a
    • Flags: construct write
  • State: The state of the PHY layer
    • Set with class: ns3::PointerValue
    • Underlying type: ns3::Ptr< ns3::WifiPhyStateHelper >
    • Initial value: 0
    • Flags: construct write read
No TraceSources defined for this type.
TraceSources defined in parent class ns3::WifiPhy:
  • PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel medium
  • PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel
  • PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission
  • PhyRxBegin: Trace source indicating a packet has begun being received from the channel medium by the device
  • PhyRxEnd: Trace source indicating a packet has been completely received from the channel medium by the device
  • PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception
  • PromiscSnifferRx: Trace source simulating a wifi device in monitor mode sniffing all received frames
  • PromiscSnifferTx: Trace source simulating the capability of a wifi device in monitor mode to sniff all frames being transmitted

Reimplemented from ns3::WifiPhy.

virtual bool ns3::YansWifiPhy::IsStateBusy ( void   )  [virtual]

Returns:
true of the current state of the PHY layer is not WifiPhy::IDLE, false otherwise.

Implements ns3::WifiPhy.

virtual bool ns3::YansWifiPhy::IsStateCcaBusy ( void   )  [virtual]

Returns:
true of the current state of the PHY layer is WifiPhy::CCA_BUSY, false otherwise.

Implements ns3::WifiPhy.

virtual bool ns3::YansWifiPhy::IsStateIdle ( void   )  [virtual]

Returns:
true of the current state of the PHY layer is WifiPhy::IDLE, false otherwise.

Implements ns3::WifiPhy.

virtual bool ns3::YansWifiPhy::IsStateSync ( void   )  [virtual]

Returns:
true of the current state of the PHY layer is WifiPhy::SYNC, false otherwise.

Implements ns3::WifiPhy.

virtual bool ns3::YansWifiPhy::IsStateTx ( void   )  [virtual]

Returns:
true of the current state of the PHY layer is WifiPhy::TX, false otherwise.

Implements ns3::WifiPhy.

virtual void ns3::YansWifiPhy::RegisterListener ( WifiPhyListener *  listener  )  [virtual]

Parameters:
listener the new listener
Add the input listener to the list of objects to be notified of PHY-level events.

Implements ns3::WifiPhy.

virtual void ns3::YansWifiPhy::SendPacket ( Ptr< const Packet >  packet,
WifiMode  mode,
enum WifiPreamble  preamble,
uint8_t  txPowerLevel 
) [virtual]

Parameters:
packet the packet to send
mode the transmission mode to use to send this packet
preamble the type of preamble to use to send this packet.
txPowerLevel a power level to use to send this packet. The real transmission power is calculated as txPowerMin + txPowerLevel * (txPowerMax - txPowerMin) / nTxLevels

Implements ns3::WifiPhy.

virtual void ns3::YansWifiPhy::SetReceiveErrorCallback ( WifiPhy::SyncErrorCallback  callback  )  [virtual]

Parameters:
callback the callback to invoke upon erronous packet reception.

Implements ns3::WifiPhy.

virtual void ns3::YansWifiPhy::SetReceiveOkCallback ( WifiPhy::SyncOkCallback  callback  )  [virtual]

Parameters:
callback the callback to invoke upon successful packet reception.

Implements ns3::WifiPhy.

The documentation for this class was generated from the following files:
Generated on Fri Apr 9 15:01:10 2010 for NS-3 by  doxygen 1.5.8