#include <introspected-doxygen.hpp>

Detailed Description

Config Paths

ns3::SpectrumWifiPhy is accessible through the following paths with Config::Set and Config::Connect:

"/NodeList/[i]/DeviceList/[i]/$ns3::WifiNetDevice/Phy/$ns3::SpectrumWifiPhy"
"/NodeList/[i]/DeviceList/[i]/$ns3::WaveNetDevice/PhyEntities/[i]/$ns3::SpectrumWifiPhy"

Attributes

DisableWifiReception: Prevent Wi-Fi frame sync from ever happening
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
TxMaskInnerBandMinimumRejection: Minimum rejection (dBr) for the inner band of the transmit spectrum mask
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: -20
- Flags: construct write read
TxMaskOuterBandMinimumRejection: Minimum rejection (dBr) for the outer band of the transmit spectrum mask
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: -28
- Flags: construct write read
TxMaskOuterBandMaximumRejection: Maximum rejection (dBr) for the outer band of the transmit spectrum mask
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: -40
- Flags: construct write read

Attributes defined in parent class ns3::WifiPhy

Frequency: The center frequency (MHz) of the operating channel. If the operating channel for this object has not been set yet, the value of this attribute is saved and will be used, along with the channel number and width configured via other attributes, to set the operating channel when the standard and band are configured. The default value of this attribute is 0, which means unspecified center frequency. Note that if center frequency and channel number are both 0 when the standard and band are configured, a default channel (of the configured width, if any, or the default width for the current standard and band, otherwise) is set. If the operating channel for this object has been already set, the specified center frequency must uniquely identify a channel in the band being used.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 0:65535
- Initial value: 0
- Flags: construct write read
ChannelNumber: The channel number of the operating channel. If the operating channel for this object has not been set yet, the value of this attribute is saved and will be used, along with the center frequency and width configured via other attributes, to set the operating channel when the standard and band are configured. The default value of this attribute is 0, which means unspecified channel number. Note that if center frequency and channel number are both 0 when the standard and band are configured, a default channel (of the configured width, if any, or the default width for the current standard and band, otherwise) is set. If the operating channel for this object has been already set, the specified channel number must uniquely identify a channel in the band being used.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:233
- Initial value: 0
- Flags: construct write read
ChannelWidth: The width in MHz of the operating channel (5, 10, 20, 22, 40, 80 or 160). If the operating channel for this object has not been set yet, the value of this attribute is saved and will be used, along with the center frequency and channel number configured via other attributes, to set the operating channel when the standard and band are configured. The default value of this attribute is 0, which means unspecified channel width. Note that if center frequency and channel number are both 0 when the standard and band are configured, a default channel (of the configured width, if any, or the default width for the current standard and band, otherwise) is set. Do not set this attribute when the standard and band of this object have been already configured, because it cannot uniquely identify a channel in the band being used.
- Set with class: ns3::UintegerValue
- Underlying type: uint16_t 5:160
- Initial value: 0
- Flags: construct write read
Primary20MHzIndex: The index of the primary 20 MHz channel within the operating channel (0 indicates the 20 MHz subchannel with the lowest center frequency). This attribute is only valid if the width of the operating channel is a multiple of 20 MHz.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:7
- Initial value: 0
- Flags: construct write
RxSensitivity: The energy of a received signal should be higher than this threshold (dBm) for the PHY to detect the signal. This threshold refers to a width of 20 MHz and will be scaled to match the width of the received signal.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: -101
- Flags: construct write read
CcaEdThreshold: The energy of a non Wi-Fi received signal should be higher than this threshold (dBm) to allow the PHY layer to declare CCA BUSY state. This check is performed on the 20 MHz primary channel only.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: -62
- Flags: construct write read
TxGain: Transmission gain (dB).
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: construct write read
RxGain: Reception gain (dB).
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 0
- Flags: construct write read
TxPowerLevels: Number of transmission power levels available between TxPowerStart and TxPowerEnd included.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 0:255
- Initial value: 1
- Flags: construct write read
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)".
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 7
- 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
ChannelSwitchDelay: Delay between two short frames transmitted on different frequencies.
- Set with class: ns3::TimeValue
- Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
- Initial value: +250000ns
- Flags: construct write read
Antennas: The number of antennas on the device.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 1:8
- Initial value: 1
- Flags: construct write read
MaxSupportedTxSpatialStreams: The maximum number of supported TX spatial streams.This parameter is only valuable for 802.11n/ac/ax STAs and APs.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 1:8
- Initial value: 1
- Flags: construct write read
MaxSupportedRxSpatialStreams: The maximum number of supported RX spatial streams.This parameter is only valuable for 802.11n/ac/ax STAs and APs.
- Set with class: ns3::UintegerValue
- Underlying type: uint8_t 1:8
- Initial value: 1
- Flags: construct write read
ShortPlcpPreambleSupported: Whether or not short PHY preamble is supported.This parameter is only valuable for 802.11b STAs and APs.Note: 802.11g APs and STAs always support short PHY preamble.
- Set with class: BooleanValue
- Underlying type: bool
- Initial value: false
- Flags: construct write read
FrameCaptureModel: Ptr to an object that implements the frame capture model
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::FrameCaptureModel>
- Initial value: 0
- Flags: construct write read
PreambleDetectionModel: Ptr to an object that implements the preamble detection model
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::PreambleDetectionModel>
- Initial value: 0
- Flags: construct write read
PostReceptionErrorModel: An optional packet error model can be added to the receive packet process after any propagation-based (SNR-based) error models have been applied. Typically this is used to force specific packet drops, for testing purposes.
- Set with class: ns3::PointerValue
- Underlying type: ns3::Ptr< ns3::ErrorModel>
- Initial value: 0
- Flags: construct write read
Sifs: The duration of the Short Interframe Space. NOTE that the default value is overwritten by the value defined by the standard; if you want to set this attribute, you have to do it after that the PHY object is initialized.
- Set with class: ns3::TimeValue
- Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: construct write read
Slot: The duration of a slot. NOTE that the default value is overwritten by the value defined by the standard; if you want to set this attribute, you have to do it after that the PHY object is initialized.
- Set with class: ns3::TimeValue
- Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: construct write read
Pifs: The duration of the PCF Interframe Space. NOTE that the default value is overwritten by the value defined by the standard; if you want to set this attribute, you have to do it after that the PHY object is initialized.
- Set with class: ns3::TimeValue
- Underlying type: Time -9.22337e+18ns:+9.22337e+18ns
- Initial value: +0ns
- Flags: construct write read
PowerDensityLimit: The mean equivalent isotropically radiated power densitylimit (in dBm/MHz) set by regulators.
- Set with class: ns3::DoubleValue
- Underlying type: double -1.79769e+308:1.79769e+308
- Initial value: 100
- Flags: construct write read

TraceSources

SignalArrival: Signal arrival
Callback signature: ns3::SpectrumWifiPhy::SignalArrivalCallback

TraceSources defined in parent class ns3::WifiPhy

PhyTxBegin: Trace source indicating a packet has begun transmitting over the channel medium
Callback signature: ns3::WifiPhy::PhyTxBeginTracedCallback
PhyTxPsduBegin: Trace source indicating a PSDU has begun transmitting over the channel medium
Callback signature: ns3::WifiPhy::PsduTxBeginCallback
PhyTxEnd: Trace source indicating a packet has been completely transmitted over the channel.
Callback signature: ns3::Packet::TracedCallback
PhyTxDrop: Trace source indicating a packet has been dropped by the device during transmission
Callback signature: ns3::Packet::TracedCallback
PhyRxBegin: Trace source indicating a packet has begun being received from the channel medium by the device
Callback signature: ns3::WifiPhy::PhyRxBeginTracedCallback
PhyRxPayloadBegin: Trace source indicating the reception of the payload of a PPDU has begun
Callback signature: ns3::WifiPhy::PhyRxPayloadBeginTracedCallback
PhyRxEnd: Trace source indicating a packet has been completely received from the channel medium by the device
Callback signature: ns3::Packet::TracedCallback
PhyRxDrop: Trace source indicating a packet has been dropped by the device during reception
Callback signature: ns3::Packet::TracedCallback
MonitorSnifferRx: Trace source simulating a wifi device in monitor mode sniffing all received frames
Callback signature: ns3::WifiPhy::MonitorSnifferRxTracedCallback
MonitorSnifferTx: Trace source simulating the capability of a wifi device in monitor mode to sniff all frames being transmitted
Callback signature: ns3::WifiPhy::MonitorSnifferTxTracedCallback

Size of this type is 992 bytes (on a 64-bit architecture).

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

ndnSIM/docs/introspected-doxygen.hpp