Abstract class for PHY entitiesThis class enables to have a unique set of APIs to be used by each PHY entity, corresponding to the different amendments of the IEEE 802.11 standard. More...

#include "phy-entity.h"

Inheritance diagram for ns3::PhyEntity:

Collaboration diagram for ns3::PhyEntity:

Classes
struct	PhyFieldRxStatus
	Status of the reception of the PPDU field. More...

struct	SnrPer
	A struct for both SNR and PER. More...

Public Types
typedef std::pair< std::pair< Time, Time >, WifiMode >	PhyHeaderChunkInfo
	A pair containing information on the PHY header chunk, namely the start and stop times of the chunk and the WifiMode used. More...

typedef std::map< WifiPpduField, PhyHeaderChunkInfo >	PhyHeaderSections
	A map of PhyHeaderChunkInfo elements per PPDU field. More...

enum	PhyRxFailureAction { DROP = 0, ABORT, IGNORE }
	Action to perform in case of RX failure. More...

Public Member Functions
virtual	~PhyEntity ()
	Destructor for PHY entity. More...

std::list< WifiMode >::const_iterator	begin (void) const
	Return a const iterator to the first WifiMode. More...

virtual Ptr< WifiPpdu >	BuildPpdu (const WifiConstPsduMap &psdus, const WifiTxVector &txVector, Time ppduDuration)
	Build amendment-specific PPDU. More...

Time	CalculatePhyPreambleAndHeaderDuration (const WifiTxVector &txVector) const

virtual Time	CalculateTxDuration (WifiConstPsduMap psduMap, const WifiTxVector &txVector, WifiPhyBand band) const

virtual void	CancelAllEvents (void)
	Cancel and clear all running events. More...

void	CancelRunningEndPreambleDetectionEvents (bool clear=false)
	Cancel and eventually clear all end preamble detection events. More...

std::list< WifiMode >::const_iterator	end (void) const
	Return a const iterator to past-the-last WifiMode. More...

void	EndReceiveField (WifiPpduField field, Ptr< Event > event)
	End receiving a given field. More...

void	EndReceivePayload (Ptr< Event > event)
	The last symbol of the PPDU has arrived. More...

virtual Ptr< const WifiPsdu >	GetAddressedPsduInPpdu (Ptr< const WifiPpdu > ppdu) const
	Get the PSDU addressed to that PHY in a PPDU (useful for MU PPDU). More...

virtual Time	GetDuration (WifiPpduField field, const WifiTxVector &txVector) const
	Get the duration of the PPDU field (or group of fields) used by this entity for the given transmission parameters. More...

Time	GetDurationUpToField (WifiPpduField field, const WifiTxVector &txVector) const
	Get the duration of the PPDU up to (but excluding) the given field. More...

virtual uint32_t	GetMaxPsduSize (void) const =0
	Get the maximum PSDU size in bytes. More...

virtual WifiMode	GetMcs (uint8_t index) const
	Get the WifiMode corresponding to the given MCS index. More...

virtual uint16_t	GetMeasurementChannelWidth (const Ptr< const WifiPpdu > ppdu) const
	Return the channel width used to measure the RSSI. More...

WifiPpduField	GetNextField (WifiPpduField currentField, WifiPreamble preamble) const
	Return the field following the provided one. More...

virtual uint8_t	GetNumModes (void) const

virtual Time	GetPayloadDuration (uint32_t size, const WifiTxVector &txVector, WifiPhyBand band, MpduType mpdutype, bool incFlag, uint32_t &totalAmpduSize, double &totalAmpduNumSymbols, uint16_t staId) const =0

PhyHeaderSections	GetPhyHeaderSections (const WifiTxVector &txVector, Time ppduStart) const
	Return a map of PHY header chunk information per PPDU field. More...

Time	GetRemainingDurationAfterField (Ptr< const WifiPpdu > ppdu, WifiPpduField field) const
	Get the remaining duration of the PPDU after the end of the given field. More...

virtual uint16_t	GetRxChannelWidth (const WifiTxVector &txVector) const
	Return the channel width used in the reception spectrum model. More...

virtual WifiMode	GetSigMode (WifiPpduField field, const WifiTxVector &txVector) const
	Get the WifiMode for the SIG field specified by the PPDU field. More...

virtual uint16_t	GetStaId (const Ptr< const WifiPpdu > ppdu) const
	Return the STA ID that has been assigned to the station this PHY belongs to. More...

virtual WifiConstPsduMap	GetWifiConstPsduMap (Ptr< const WifiPsdu > psdu, const WifiTxVector &txVector) const
	Get a WifiConstPsduMap from a PSDU and the TXVECTOR to use to send the PSDU. More...

virtual bool	HandlesMcsModes (void) const
	Check if the WifiModes handled by this PHY are MCSs. More...

virtual bool	IsMcsSupported (uint8_t index) const
	Check if the WifiMode corresponding to the given MCS index is supported. More...

virtual bool	IsModeSupported (WifiMode mode) const
	Check if the WifiMode is supported. More...

bool	NoEndPreambleDetectionEvents (void) const

void	ResetReceive (Ptr< Event > event)
	Reset PHY at the end of the PPDU under reception after it has failed the PHY header. More...

void	SetOwner (Ptr< WifiPhy > wifiPhy)
	Set the WifiPhy owning this PHY entity. More...

void	StartReceiveField (WifiPpduField field, Ptr< Event > event)
	Start receiving a given field. More...

virtual void	StartReceivePreamble (Ptr< WifiPpdu > ppdu, RxPowerWattPerChannelBand rxPowersW, Time rxDuration)
	Start receiving the PHY preamble of a PPDU (i.e. More...

virtual void	StartTx (Ptr< WifiPpdu > ppdu)
	This function is called by SpectrumWifiPhy to send the PPDU while performing amendment-specific actions. More...

void	Transmit (Time txDuration, Ptr< WifiPpdu > ppdu, std::string type)
	This function prepares most of the WifiSpectrumSignalParameters parameters and invokes SpectrumWifiPhy's Transmit method. More...

Public Member Functions inherited from ns3::SimpleRefCount< PhyEntity >
	SimpleRefCount ()
	Default constructor. More...

	SimpleRefCount (const SimpleRefCount &o)
	Copy constructor. More...

uint32_t	GetReferenceCount (void) const
	Get the reference count of the object. More...

SimpleRefCount &	operator= (const SimpleRefCount &o)
	Assignment operator. More...

void	Ref (void) const
	Increment the reference count. More...

void	Unref (void) const
	Decrement the reference count. More...

Protected Types
typedef std::pair< WifiCodeRate, uint16_t >	CodeRateConstellationSizePair
	A pair to hold modulation information: code rate and constellation size. More...

typedef std::map< std::string, CodeRateConstellationSizePair >	ModulationLookupTable
	A modulation lookup table using unique name of modulation as key. More...

typedef std::map< WifiPreamble, std::vector< WifiPpduField > >	PpduFormats
	A map of PPDU field elements per preamble type. More...

typedef std::pair< uint64_t, uint16_t >	UidStaIdPair
	A pair of a UID and STA_ID. More...

Protected Member Functions
void	AbortCurrentReception (WifiPhyRxfailureReason reason)
	Abort the current reception. More...

void	AddPreambleEvent (Ptr< Event > event)
	Add an entry to the map of current preamble events (stored in WifiPhy). More...

Ptr< Event >	CreateInterferenceEvent (Ptr< const WifiPpdu > ppdu, const WifiTxVector &txVector, Time duration, RxPowerWattPerChannelBand rxPower, bool isStartOfdmaRxing=false)
	Create an event using WifiPhy's InterferenceHelper class. More...

virtual void	DoAbortCurrentReception (WifiPhyRxfailureReason reason)
	Perform amendment-specific actions before aborting the current reception. More...

virtual PhyFieldRxStatus	DoEndReceiveField (WifiPpduField field, Ptr< Event > event)
	End receiving a given field, perform amendment-specific actions, and provide the status of the reception. More...

virtual void	DoEndReceivePayload (Ptr< const WifiPpdu > ppdu)
	Perform amendment-specific actions at the end of the reception of the payload. More...

virtual PhyFieldRxStatus	DoEndReceivePreamble (Ptr< Event > event)
	End receiving the preamble, perform amendment-specific actions, and provide the status of the reception. More...

virtual Ptr< Event >	DoGetEvent (Ptr< const WifiPpdu > ppdu, RxPowerWattPerChannelBand rxPowersW)
	Get the event corresponding to the incoming PPDU. More...

virtual void	DoResetReceive (Ptr< Event > event)
	Perform amendment-specific actions before resetting PHY at the end of the PPDU under reception after it has failed the PHY header. More...

virtual bool	DoStartReceiveField (WifiPpduField field, Ptr< Event > event)
	Start receiving a given field, perform amendment-specific actions, and signify if it is supported. More...

virtual void	DoStartReceivePayload (Ptr< Event > event)
	Start receiving the PSDU (i.e. More...

void	DropPreambleEvent (Ptr< const WifiPpdu > ppdu, WifiPhyRxfailureReason reason, Time endRx, uint16_t measurementChannelWidth)
	Drop the PPDU and the corresponding preamble detection event, but keep CCA busy state after the completion of the currently processed event. More...

void	EndOfMpdu (Ptr< Event > event, Ptr< const WifiPsdu > psdu, size_t mpduIndex, Time relativeStart, Time mpduDuration)
	The last symbol of an MPDU in an A-MPDU has arrived. More...

void	EndPreambleDetectionPeriod (Ptr< Event > event)
	End the preamble detection period. More...

void	ErasePreambleEvent (Ptr< const WifiPpdu > ppdu, Time rxDuration)
	Erase the event corresponding to the PPDU from the list of preamble events, but consider it as noise after the completion of the current event. More...

uint16_t	GetCenterFrequencyForChannelWidth (const WifiTxVector &txVector) const
	Get the center frequency of the channel corresponding the current TxVector rather than that of the supported channel width. More...

virtual std::pair< uint16_t, WifiSpectrumBand >	GetChannelWidthAndBand (const WifiTxVector &txVector, uint16_t staId) const
	Get the channel width and band to use (will be overloaded by child classes). More...

Ptr< const Event >	GetCurrentEvent (void) const
	Get the pointer to the current event (stored in WifiPhy). More...

const std::map< std::pair< uint64_t, WifiPreamble >, Ptr< Event > > &	GetCurrentPreambleEvents (void) const
	Get the map of current preamble events (stored in WifiPhy). More...

uint16_t	GetGuardBandwidth (uint16_t currentChannelWidth) const

SnrPer	GetPhyHeaderSnrPer (WifiPpduField field, Ptr< Event > event) const
	Obtain the SNR and PER of the PPDU field from the WifiPhy's InterferenceHelper class. More...

virtual const PpduFormats &	GetPpduFormats (void) const =0
	Return the PPDU formats of the PHY. More...

double	GetRandomValue (void) const
	Obtain a random value from the WifiPhy's generator. More...

std::pair< bool, SignalNoiseDbm >	GetReceptionStatus (Ptr< const WifiPsdu > psdu, Ptr< Event > event, uint16_t staId, Time relativeMpduStart, Time mpduDuration)
	Get the reception status for the provided MPDU and notify. More...

double	GetRxPowerWForPpdu (Ptr< Event > event) const
	Obtain the received power (W) for a given band. More...

std::tuple< double, double, double >	GetTxMaskRejectionParams (void) const

virtual Ptr< SpectrumValue >	GetTxPowerSpectralDensity (double txPowerW, Ptr< const WifiPpdu > ppdu) const =0

virtual bool	IsConfigSupported (Ptr< const WifiPpdu > ppdu) const
	Checks if the signaled configuration (excluding bandwidth) is supported by the PHY. More...

void	NotifyInterferenceRxEndAndClear (bool reset)
	Notify WifiPhy's InterferenceHelper of the end of the reception, clear maps and end of MPDU event, and eventually reset WifiPhy. More...

virtual uint64_t	ObtainNextUid (const WifiTxVector &txVector)
	Obtain the next UID for the PPDU to transmit. More...

void	ScheduleEndOfMpdus (Ptr< Event > event)
	Schedule end of MPDUs events. More...

void	StartPreambleDetectionPeriod (Ptr< Event > event)
	Start the preamble detection period. More...

void	StartReceivePayload (Ptr< Event > event)
	Start receiving the PSDU (i.e. More...

void	UpdateInterferenceEvent (Ptr< Event > event, RxPowerWattPerChannelBand rxPower)
	Update an event in WifiPhy's InterferenceHelper class. More...

Protected Attributes
std::vector< EventId >	m_endOfMpduEvents
	the end of MPDU events (only used for A-MPDUs) More...

std::vector< EventId >	m_endPreambleDetectionEvents
	the end of preamble detection events More...

std::vector< EventId >	m_endRxPayloadEvents
	the end of receive events (only one unless UL MU reception) More...

std::list< WifiMode >	m_modeList
	the list of supported modes More...

std::map< UidStaIdPair, SignalNoiseDbm >	m_signalNoiseMap
	Map of the latest signal power and noise power in dBm (noise power includes the noise figure) More...

Ptr< WifiPhyStateHelper >	m_state
	Pointer to WifiPhyStateHelper of the WifiPhy (to make it reachable for child classes) More...

std::map< UidStaIdPair, std::vector< bool > >	m_statusPerMpduMap
	Map of the current reception status per MPDU that is filled in as long as MPDUs are being processed by the PHY in case of an A-MPDU. More...

Ptr< WifiPhy >	m_wifiPhy
	Pointer to the owning WifiPhy. More...

Static Protected Attributes
static uint64_t	m_globalPpduUid = 0
	Global counter of the PPDU UID. More...

Detailed Description

Abstract class for PHY entities

This class enables to have a unique set of APIs to be used by each PHY entity, corresponding to the different amendments of the IEEE 802.11 standard.

Definition at line 93 of file phy-entity.h.

Member Typedef Documentation

◆ CodeRateConstellationSizePair

typedef std::pair<WifiCodeRate, uint16_t> ns3::PhyEntity::CodeRateConstellationSizePair

protected

A pair to hold modulation information: code rate and constellation size.

Definition at line 482 of file phy-entity.h.

◆ ModulationLookupTable

typedef std::map<std::string, CodeRateConstellationSizePair> ns3::PhyEntity::ModulationLookupTable

protected

A modulation lookup table using unique name of modulation as key.

Definition at line 487 of file phy-entity.h.

◆ PhyHeaderChunkInfo

typedef std::pair<std::pair<Time , Time >, WifiMode> ns3::PhyEntity::PhyHeaderChunkInfo

A pair containing information on the PHY header chunk, namely the start and stop times of the chunk and the WifiMode used.

Definition at line 296 of file phy-entity.h.

◆ PhyHeaderSections

typedef std::map<WifiPpduField, PhyHeaderChunkInfo> ns3::PhyEntity::PhyHeaderSections

A map of PhyHeaderChunkInfo elements per PPDU field.

See also: PhyHeaderChunkInfo

Definition at line 301 of file phy-entity.h.

◆ PpduFormats

typedef std::map<WifiPreamble, std::vector<WifiPpduField> > ns3::PhyEntity::PpduFormats

protected

A map of PPDU field elements per preamble type.

This corresponds to the different PPDU formats introduced by each amendment.

Definition at line 477 of file phy-entity.h.

◆ UidStaIdPair

typedef std::pair<uint64_t , uint16_t > ns3::PhyEntity::UidStaIdPair

protected

A pair of a UID and STA_ID.

Definition at line 796 of file phy-entity.h.

Member Enumeration Documentation

◆ PhyRxFailureAction

enum ns3::PhyEntity::PhyRxFailureAction

Action to perform in case of RX failure.

Enumerator
DROP	drop PPDU and set CCA_BUSY
ABORT	abort reception of PPDU
IGNORE	ignore the reception

Definition at line 100 of file phy-entity.h.

Constructor & Destructor Documentation

◆ ~PhyEntity()

ns3::PhyEntity::~PhyEntity ( )

virtual

Destructor for PHY entity.

Definition at line 74 of file phy-entity.cc.

References CancelAllEvents(), m_modeList, and NS_LOG_FUNCTION.

Here is the call graph for this function:

Member Function Documentation

◆ AbortCurrentReception()

void ns3::PhyEntity::AbortCurrentReception ( WifiPhyRxfailureReason reason )

protected

Abort the current reception.

Parameters

reason the reason the reception is aborted

Definition at line 952 of file phy-entity.cc.

References ns3::WifiPhy::AbortCurrentReception(), DoAbortCurrentReception(), m_wifiPhy, and NS_LOG_FUNCTION.

Referenced by EndReceiveField(), and StartReceivePreamble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddPreambleEvent()

void ns3::PhyEntity::AddPreambleEvent ( Ptr< Event > event )

protected

Add an entry to the map of current preamble events (stored in WifiPhy).

Wrapper used by child classes.

Parameters

event the event holding incoming PPDU's information

Definition at line 731 of file phy-entity.cc.

References ns3::WifiPhy::m_currentPreambleEvents, m_wifiPhy, and NS_LOG_FUNCTION.

Referenced by ns3::HePhy::DoGetEvent().

Here is the caller graph for this function:

◆ begin()

std::list< WifiMode >::const_iterator ns3::PhyEntity::begin ( void ) const

Return a const iterator to the first WifiMode.

Returns: a const iterator to the first WifiMode.

Definition at line 129 of file phy-entity.cc.

References m_modeList.

◆ BuildPpdu()

Ptr< WifiPpdu > ns3::PhyEntity::BuildPpdu	(	const WifiConstPsduMap &	psdus,
		const WifiTxVector &	txVector,
		Time	ppduDuration
	)

virtual

Build amendment-specific PPDU.

Parameters

psdus	the PHY payloads (PSDUs)
txVector	the TXVECTOR that was used for the PPDU
ppduDuration	the transmission duration of the PPDU

Returns: the amendment-specific WifiPpdu

Reimplemented in ns3::HePhy, ns3::OfdmPhy, ns3::HtPhy, ns3::VhtPhy, ns3::DsssPhy, and ns3::ErpOfdmPhy.

Definition at line 228 of file phy-entity.cc.

References NS_FATAL_ERROR, and NS_LOG_FUNCTION.

◆ CalculatePhyPreambleAndHeaderDuration()

Time ns3::PhyEntity::CalculatePhyPreambleAndHeaderDuration ( const WifiTxVector & txVector ) const

Parameters

txVector the transmission parameters

Returns: the total duration of the PHY preamble and PHY header.

Definition at line 186 of file phy-entity.cc.

References GetDuration(), ns3::MicroSeconds(), ns3::WIFI_PPDU_FIELD_DATA, and ns3::WIFI_PPDU_FIELD_PREAMBLE.

Referenced by ns3::HePhy::DoStartReceivePayload(), DoStartReceivePayload(), EndReceivePayload(), GetDurationUpToField(), ScheduleEndOfMpdus(), ns3::HePhy::StartReceiveOfdmaPayload(), and StartReceivePayload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ CalculateTxDuration()

Time ns3::PhyEntity::CalculateTxDuration	(	WifiConstPsduMap	psduMap,
		const WifiTxVector &	txVector,
		WifiPhyBand	band
	)		const

virtual

Parameters

psduMap	the PSDU(s) to transmit indexed by STA-ID
txVector	the TXVECTOR used for the transmission of the PPDU
band	the frequency band being used

Returns: the total amount of time this PHY will stay busy for the transmission of the PPDU

Reimplemented in ns3::HePhy.

Definition at line 1073 of file phy-entity.cc.

References ns3::WifiPhy::CalculateTxDuration(), and NS_ASSERT.

Here is the call graph for this function:

◆ CancelAllEvents()

void ns3::PhyEntity::CancelAllEvents ( void )

virtual

Cancel and clear all running events.

Reimplemented in ns3::HePhy.

Definition at line 913 of file phy-entity.cc.

References m_endPreambleDetectionEvents, m_endRxPayloadEvents, and NS_LOG_FUNCTION.

Referenced by ns3::HePhy::CancelAllEvents(), and ~PhyEntity().

Here is the caller graph for this function:

◆ CancelRunningEndPreambleDetectionEvents()

void ns3::PhyEntity::CancelRunningEndPreambleDetectionEvents ( bool clear = false )

Cancel and eventually clear all end preamble detection events.

Parameters

clear whether to clear the end preamble detection events' list

Definition at line 935 of file phy-entity.cc.

References m_endPreambleDetectionEvents, and NS_LOG_FUNCTION.

◆ CreateInterferenceEvent()

Ptr< Event > ns3::PhyEntity::CreateInterferenceEvent	(	Ptr< const WifiPpdu >	ppdu,
		const WifiTxVector &	txVector,
		Time	duration,
		RxPowerWattPerChannelBand	rxPower,
		bool	isStartOfdmaRxing = `false`
	)

protected

Create an event using WifiPhy's InterferenceHelper class.

Wrapper used by child classes.

Add the PPDU-related signal to interference helper.

Parameters

ppdu	the PPDU
txVector	the TXVECTOR
duration	the PPDU duration
rxPower	received power per band (W)
isStartOfdmaRxing	flag whether the event corresponds to the start of the OFDMA payload reception (only used for UL-OFDMA) //TODO simplify this once WifiPpdu is subclassed by adding an attribute

Returns: Event

Definition at line 751 of file phy-entity.cc.

References ns3::InterferenceHelper::Add(), ns3::WifiPhy::m_interference, and m_wifiPhy.

Referenced by ns3::HePhy::DoGetEvent(), DoGetEvent(), and ns3::HePhy::StartReceivePreamble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoAbortCurrentReception()

void ns3::PhyEntity::DoAbortCurrentReception ( WifiPhyRxfailureReason reason )

protectedvirtual

Perform amendment-specific actions before aborting the current reception.

Parameters

reason the reason the reception is aborted

Reimplemented in ns3::HePhy.

Definition at line 960 of file phy-entity.cc.

References ns3::WifiPhy::m_currentEvent, m_endOfMpduEvents, m_wifiPhy, and NS_LOG_FUNCTION.

Referenced by AbortCurrentReception(), and ns3::HePhy::DoAbortCurrentReception().

Here is the caller graph for this function:

◆ DoEndReceiveField()

PhyEntity::PhyFieldRxStatus ns3::PhyEntity::DoEndReceiveField	(	WifiPpduField	field,
		Ptr< Event >	event
	)

protectedvirtual

End receiving a given field, perform amendment-specific actions, and provide the status of the reception.

Parameters

field	the ending PPDU field
event	the event holding incoming PPDU's information

Returns: status of the reception of the PPDU field

Reimplemented in ns3::HtPhy, ns3::OfdmPhy, ns3::VhtPhy, and ns3::DsssPhy.

Definition at line 350 of file phy-entity.cc.

References DoEndReceivePreamble(), NS_ASSERT, NS_LOG_FUNCTION, ns3::WIFI_PPDU_FIELD_DATA, and ns3::WIFI_PPDU_FIELD_PREAMBLE.

Referenced by ns3::DsssPhy::DoEndReceiveField(), ns3::OfdmPhy::DoEndReceiveField(), and EndReceiveField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoEndReceivePayload()

void ns3::PhyEntity::DoEndReceivePayload ( Ptr< const WifiPpdu > ppdu )

protectedvirtual

Perform amendment-specific actions at the end of the reception of the payload.

Parameters

ppdu	the incoming PPDU

Reimplemented in ns3::HePhy.

Definition at line 672 of file phy-entity.cc.

References ns3::WifiPhy::GetLastRxEndTime(), ns3::WifiPhy::m_currentEvent, ns3::WifiPhy::m_currentPreambleEvents, m_endRxPayloadEvents, m_wifiPhy, NotifyInterferenceRxEndAndClear(), ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ns3::HePhy::DoEndReceivePayload(), and EndReceivePayload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoEndReceivePreamble()

PhyEntity::PhyFieldRxStatus ns3::PhyEntity::DoEndReceivePreamble ( Ptr< Event > event )

protectedvirtual

End receiving the preamble, perform amendment-specific actions, and provide the status of the reception.

Parameters

event the event holding incoming PPDU's information

Returns: status of the reception of the preamble

Definition at line 780 of file phy-entity.cc.

References ns3::WifiPhy::m_currentPreambleEvents, m_wifiPhy, NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by DoEndReceiveField().

Here is the caller graph for this function:

◆ DoGetEvent()

Ptr< Event > ns3::PhyEntity::DoGetEvent	(	Ptr< const WifiPpdu >	ppdu,
		RxPowerWattPerChannelBand	rxPowersW
	)

protectedvirtual

Get the event corresponding to the incoming PPDU.

We store all incoming preamble events, perform amendment-specific actions, and a decision is made at the end of the preamble detection window.

Parameters

ppdu	the incoming PPDU
rxPowersW	the receive power in W per band

Returns: the event holding the incoming PPDU's information

Reimplemented in ns3::HePhy.

Definition at line 739 of file phy-entity.cc.

References CreateInterferenceEvent(), ns3::WifiPhy::m_currentPreambleEvents, m_wifiPhy, and NS_ASSERT.

Referenced by ns3::HePhy::DoGetEvent(), and StartReceivePreamble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoResetReceive()

void ns3::PhyEntity::DoResetReceive ( Ptr< Event > event )

protectedvirtual

Perform amendment-specific actions before resetting PHY at the end of the PPDU under reception after it has failed the PHY header.

Parameters

event the event holding incoming PPDU's information

Reimplemented in ns3::HePhy.

Definition at line 984 of file phy-entity.cc.

References ns3::Simulator::Now(), NS_ASSERT, and NS_LOG_FUNCTION.

Referenced by ResetReceive().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoStartReceiveField()

bool ns3::PhyEntity::DoStartReceiveField	(	WifiPpduField	field,
		Ptr< Event >	event
	)

protectedvirtual

Start receiving a given field, perform amendment-specific actions, and signify if it is supported.

Parameters

field	the starting PPDU field
event	the event holding incoming PPDU's information

Returns: true if the field is supported, false otherwise

Definition at line 332 of file phy-entity.cc.

References GetPpduFormats(), NS_ASSERT, NS_LOG_FUNCTION, ns3::WIFI_PPDU_FIELD_DATA, and ns3::WIFI_PPDU_FIELD_PREAMBLE.

Referenced by StartReceiveField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DoStartReceivePayload()

void ns3::PhyEntity::DoStartReceivePayload ( Ptr< Event > event )

protectedvirtual

Start receiving the PSDU (i.e.

the first symbol of the PSDU has arrived) and perform amendment-specific actions.

Parameters

event the event holding incoming PPDU's information

Reimplemented in ns3::HePhy.

Definition at line 540 of file phy-entity.cc.

References CalculatePhyPreambleAndHeaderDuration(), EndReceivePayload(), GetStaId(), m_endRxPayloadEvents, m_signalNoiseMap, m_statusPerMpduMap, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ScheduleEndOfMpdus().

Referenced by ns3::HePhy::DoStartReceivePayload(), and StartReceivePayload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ DropPreambleEvent()

void ns3::PhyEntity::DropPreambleEvent	(	Ptr< const WifiPpdu >	ppdu,
		WifiPhyRxfailureReason	reason,
		Time	endRx,
		uint16_t	measurementChannelWidth
	)

protected

Drop the PPDU and the corresponding preamble detection event, but keep CCA busy state after the completion of the currently processed event.

Parameters

ppdu	the incoming PPDU
reason	the reason the PPDU is dropped
endRx	the end of the incoming PPDU's reception
measurementChannelWidth	the measurement width (in MHz) to consider for the PPDU

Definition at line 481 of file phy-entity.cc.

References GetAddressedPsduInPpdu(), ns3::WifiPhy::m_currentPreambleEvents, m_state, m_wifiPhy, ns3::WifiPhy::MaybeCcaBusyDuration(), ns3::WifiPhy::NotifyRxDrop(), ns3::Simulator::Now(), and NS_LOG_FUNCTION.

Referenced by EndPreambleDetectionPeriod(), and StartReceivePreamble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ end()

std::list< WifiMode >::const_iterator ns3::PhyEntity::end ( void ) const

Return a const iterator to past-the-last WifiMode.

Returns: a const iterator to past-the-last WifiMode.

Definition at line 135 of file phy-entity.cc.

References m_modeList.

◆ EndOfMpdu()

void ns3::PhyEntity::EndOfMpdu	(	Ptr< Event >	event,
		Ptr< const WifiPsdu >	psdu,
		size_t	mpduIndex,
		Time	relativeStart,
		Time	mpduDuration
	)

protected

The last symbol of an MPDU in an A-MPDU has arrived.

Parameters

event	the event holding incoming PPDU's information
psdu	the arriving MPDU formatted as a PSDU containing a normal MPDU
mpduIndex	the index of the MPDU within the A-MPDU
relativeStart	the relative start time of the MPDU within the A-MPDU.
mpduDuration	the duration of the MPDU

Definition at line 600 of file phy-entity.cc.

References ns3::Time::As(), ns3::InterferenceHelper::CalculateSnr(), ns3::Copy(), GetAddressedPsduInPpdu(), GetChannelWidthAndBand(), ns3::WifiTxVector::GetNss(), GetReceptionStatus(), GetStaId(), ns3::WifiPhy::m_interference, m_signalNoiseMap, m_state, m_statusPerMpduMap, m_wifiPhy, ns3::Time::NS, NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::RxSignalInfo::rssi, and ns3::RxSignalInfo::snr.

Referenced by ScheduleEndOfMpdus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EndPreambleDetectionPeriod()

void ns3::PhyEntity::EndPreambleDetectionPeriod ( Ptr< Event > event )

protected

End the preamble detection period.

The PHY will focus on the strongest PPDU and drop others. In addition, in case of successful detection, the end of the preamble reception is triggered (

See also: DoEndReceivePreamble).

Parameters

event the event holding incoming PPDU's information

Definition at line 797 of file phy-entity.cc.

References ns3::BUSY_DECODING_PREAMBLE, ns3::InterferenceHelper::CalculateSnr(), ns3::EventId::Cancel(), DropPreambleEvent(), EndReceiveField(), GetAddressedPsduInPpdu(), GetDuration(), GetMeasurementChannelWidth(), ns3::WifiPhy::GetMeasurementChannelWidth(), ns3::WifiPhy::GetPreambleDetectionDuration(), ns3::WifiPhy::GetPrimaryBand(), ns3::EventId::IsExpired(), ns3::WifiPhy::IsStateRx(), ns3::WifiPhy::m_currentEvent, ns3::WifiPhy::m_currentPreambleEvents, ns3::WifiPhy::m_endPhyRxEvent, ns3::WifiPhy::m_interference, ns3::WifiPhy::m_phyEntities, ns3::WifiPhy::m_preambleDetectionModel, m_state, ns3::WifiPhy::m_timeLastPreambleDetected, m_wifiPhy, ns3::WifiPhy::NotifyRxBegin(), ns3::WifiPhy::NotifyRxDrop(), ns3::InterferenceHelper::NotifyRxEnd(), ns3::InterferenceHelper::NotifyRxStart(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::PREAMBLE_DETECT_FAILURE, ns3::PREAMBLE_DETECTION_PACKET_SWITCH, ns3::RatioToDb(), ns3::Simulator::Schedule(), and ns3::WIFI_PPDU_FIELD_PREAMBLE.

Referenced by StartPreambleDetectionPeriod().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EndReceiveField()

void ns3::PhyEntity::EndReceiveField	(	WifiPpduField	field,
		Ptr< Event >	event
	)

End receiving a given field.

This method will call the DoEndReceiveField to obtain the outcome of the reception. In case of success, reception of the next field is triggered. In case of failure, the indications in the returned

See also: PhyFieldRxStatus are performed.

Parameters

field	the ending PPDU field
event	the event holding incoming PPDU's information

Definition at line 279 of file phy-entity.cc.

References ABORT, AbortCurrentReception(), DoEndReceiveField(), DROP, ns3::FILTERED, GetAddressedPsduInPpdu(), GetMeasurementChannelWidth(), GetNextField(), ns3::WifiTxVector::GetPreambleType(), GetRemainingDurationAfterField(), IGNORE, ns3::EventId::IsExpired(), ns3::WifiPhy::m_endPhyRxEvent, m_endRxPayloadEvents, ns3::WifiPhy::m_phyRxPayloadBeginTrace, m_state, m_wifiPhy, ns3::WifiPhy::MaybeCcaBusyDuration(), ns3::NanoSeconds(), ns3::WifiPhy::NotifyRxDrop(), ns3::Simulator::Now(), NS_ASSERT, NS_FATAL_ERROR, NS_LOG_FUNCTION, ResetReceive(), ns3::Simulator::Schedule(), and StartReceiveField().

Referenced by EndPreambleDetectionPeriod(), and StartReceiveField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ EndReceivePayload()

void ns3::PhyEntity::EndReceivePayload ( Ptr< Event > event )

The last symbol of the PPDU has arrived.

Parameters

event the event holding incoming PPDU's information

Definition at line 633 of file phy-entity.cc.

References CalculatePhyPreambleAndHeaderDuration(), ns3::InterferenceHelper::CalculateSnr(), ns3::Copy(), DoEndReceivePayload(), GetAddressedPsduInPpdu(), GetChannelWidthAndBand(), ns3::WifiPhy::GetFrequency(), GetMeasurementChannelWidth(), ns3::WifiTxVector::GetNss(), GetStaId(), ns3::WifiPhy::m_interference, ns3::WifiPhy::m_previouslyRxPpduUid, m_signalNoiseMap, m_state, m_statusPerMpduMap, m_wifiPhy, ns3::WifiPhy::MaybeCcaBusyDuration(), ns3::WifiPhy::NotifyMonitorSniffRx(), ns3::WifiPhy::NotifyRxEnd(), ns3::Simulator::Now(), NS_ASSERT, NS_LOG_FUNCTION, ns3::RxSignalInfo::rssi, and ns3::RxSignalInfo::snr.

Referenced by DoStartReceivePayload(), and ns3::HePhy::StartReceiveOfdmaPayload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ErasePreambleEvent()

void ns3::PhyEntity::ErasePreambleEvent	(	Ptr< const WifiPpdu >	ppdu,
		Time	rxDuration
	)

protected

Erase the event corresponding to the PPDU from the list of preamble events, but consider it as noise after the completion of the current event.

Parameters

ppdu	the incoming PPDU
rxDuration	the duration of the PPDU

Definition at line 498 of file phy-entity.cc.

References GetMeasurementChannelWidth(), ns3::WifiPhy::m_currentPreambleEvents, m_state, m_wifiPhy, NS_LOG_FUNCTION, ns3::WifiPhy::Reset(), and ns3::WifiPhy::SwitchMaybeToCcaBusy().

Referenced by ns3::HePhy::StartReceivePreamble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetAddressedPsduInPpdu()

Ptr< const WifiPsdu > ns3::PhyEntity::GetAddressedPsduInPpdu ( Ptr< const WifiPpdu > ppdu ) const

virtual

Get the PSDU addressed to that PHY in a PPDU (useful for MU PPDU).

Parameters

ppdu	the PPDU to extract the PSDU from

Returns: the PSDU addressed to that PHY

Reimplemented in ns3::HePhy.

Definition at line 203 of file phy-entity.cc.

Referenced by DropPreambleEvent(), EndOfMpdu(), EndPreambleDetectionPeriod(), EndReceiveField(), EndReceivePayload(), ns3::HePhy::GetAddressedPsduInPpdu(), and ScheduleEndOfMpdus().

Here is the caller graph for this function:

◆ GetCenterFrequencyForChannelWidth()

uint16_t ns3::PhyEntity::GetCenterFrequencyForChannelWidth ( const WifiTxVector & txVector ) const

protected

Get the center frequency of the channel corresponding the current TxVector rather than that of the supported channel width.

Consider that this "primary channel" is on the lower part for the time being.

Parameters

txVector the TXVECTOR that has the channel width that is to be used

Returns: the center frequency in MHz corresponding to the channel width to be used

Definition at line 1028 of file phy-entity.cc.

References ns3::WifiTxVector::GetChannelWidth(), ns3::WifiPhy::GetOperatingChannel(), ns3::WifiPhyOperatingChannel::GetPrimaryChannelCenterFrequency(), m_wifiPhy, and NS_LOG_FUNCTION.

Referenced by ns3::HePhy::GetCenterFrequencyForNonOfdmaPart(), ns3::DsssPhy::GetTxPowerSpectralDensity(), ns3::OfdmPhy::GetTxPowerSpectralDensity(), ns3::HePhy::GetTxPowerSpectralDensity(), and ns3::HtPhy::GetTxPowerSpectralDensity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetChannelWidthAndBand()

std::pair< uint16_t, WifiSpectrumBand > ns3::PhyEntity::GetChannelWidthAndBand	(	const WifiTxVector &	txVector,
		uint16_t	staId
	)		const

protectedvirtual

Get the channel width and band to use (will be overloaded by child classes).

Parameters

txVector	the transmission parameters
staId	the station ID of the PSDU

Returns: a pair of channel width (MHz) and band

Reimplemented in ns3::HePhy.

Definition at line 718 of file phy-entity.cc.

References ns3::WifiPhy::GetPrimaryBand(), GetRxChannelWidth(), and m_wifiPhy.

Referenced by EndOfMpdu(), EndReceivePayload(), ns3::HePhy::GetChannelWidthAndBand(), and GetReceptionStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetCurrentEvent()

Ptr< const Event > ns3::PhyEntity::GetCurrentEvent ( void ) const

protected

Get the pointer to the current event (stored in WifiPhy).

Wrapper used by child classes.

Returns: the pointer to the current event

Definition at line 1003 of file phy-entity.cc.

References ns3::WifiPhy::m_currentEvent, and m_wifiPhy.

Referenced by ns3::HePhy::DoGetEvent(), ns3::HePhy::StartReceiveOfdmaPayload(), and ns3::HePhy::StartReceivePreamble().

Here is the caller graph for this function:

◆ GetCurrentPreambleEvents()

const std::map< std::pair< uint64_t, WifiPreamble >, Ptr< Event > > & ns3::PhyEntity::GetCurrentPreambleEvents ( void ) const

protected

Get the map of current preamble events (stored in WifiPhy).

Wrapper used by child classes.

Returns: the reference to the map of current preamble events

Definition at line 725 of file phy-entity.cc.

References ns3::WifiPhy::m_currentPreambleEvents, and m_wifiPhy.

Referenced by ns3::HePhy::DoGetEvent().

Here is the caller graph for this function:

◆ GetDuration()

Time ns3::PhyEntity::GetDuration	(	WifiPpduField	field,
		const WifiTxVector &	txVector
	)		const

virtual

Get the duration of the PPDU field (or group of fields) used by this entity for the given transmission parameters.

Parameters

field	the PPDU field (or group of fields)
txVector	the transmission parameters

Returns: the duration of the PPDU field

Reimplemented in ns3::OfdmPhy, ns3::HtPhy, ns3::VhtPhy, and ns3::DsssPhy.

Definition at line 176 of file phy-entity.cc.

References ns3::MicroSeconds(), NS_FATAL_ERROR, and ns3::WIFI_PPDU_FIELD_SIG_B.

Referenced by CalculatePhyPreambleAndHeaderDuration(), EndPreambleDetectionPeriod(), ns3::DsssPhy::GetDuration(), ns3::HtPhy::GetDuration(), ns3::OfdmPhy::GetDuration(), GetPhyHeaderSections(), GetRemainingDurationAfterField(), and StartReceiveField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDurationUpToField()

Time ns3::PhyEntity::GetDurationUpToField	(	WifiPpduField	field,
		const WifiTxVector &	txVector
	)		const

Get the duration of the PPDU up to (but excluding) the given field.

Parameters

field	the considered PPDU field
txVector	the transmission parameters

Returns: the duration from the beginning of the PPDU up to the field

Definition at line 236 of file phy-entity.cc.

References CalculatePhyPreambleAndHeaderDuration(), GetPhyHeaderSections(), ns3::NanoSeconds(), NS_ASSERT, and ns3::WIFI_PPDU_FIELD_DATA.

Referenced by GetRemainingDurationAfterField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetGuardBandwidth()

uint16_t ns3::PhyEntity::GetGuardBandwidth ( uint16_t currentChannelWidth ) const

protected

Parameters

currentChannelWidth channel width of the current transmission (MHz)

Returns: the width of the guard band (MHz)

Wrapper method used by child classes for PSD generation. Note that this method is necessary for testing UL OFDMA.

Definition at line 1061 of file phy-entity.cc.

References ns3::WifiPhy::GetGuardBandwidth(), and m_wifiPhy.

Referenced by ns3::HePhy::GetNonOfdmaBand(), ns3::HePhy::GetRuBandForRx(), ns3::HePhy::GetRuBandForTx(), ns3::DsssPhy::GetTxPowerSpectralDensity(), ns3::OfdmPhy::GetTxPowerSpectralDensity(), ns3::HePhy::GetTxPowerSpectralDensity(), and ns3::HtPhy::GetTxPowerSpectralDensity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetMaxPsduSize()

virtual uint32_t ns3::PhyEntity::GetMaxPsduSize ( void ) const

pure virtual

Get the maximum PSDU size in bytes.

Returns: the maximum PSDU size in bytes

Implemented in ns3::HtPhy, ns3::HePhy, ns3::OfdmPhy, ns3::VhtPhy, ns3::DsssPhy, and ns3::ErpOfdmPhy.

◆ GetMcs()

WifiMode ns3::PhyEntity::GetMcs ( uint8_t index ) const

virtual

Get the WifiMode corresponding to the given MCS index.

Parameters

index the index of the MCS

Returns: the WifiMode corresponding to the MCS index

This method should be used only for HtPhy and child classes.

Reimplemented in ns3::HtPhy.

Definition at line 109 of file phy-entity.cc.

References NS_ABORT_MSG.

◆ GetMeasurementChannelWidth()

uint16_t ns3::PhyEntity::GetMeasurementChannelWidth ( const Ptr< const WifiPpdu > ppdu ) const

virtual

Return the channel width used to measure the RSSI.

Parameters

ppdu	the PPDU that is being received

Returns: the channel width (in MHz) used for RSSI measurement

Reimplemented in ns3::HePhy.

Definition at line 1009 of file phy-entity.cc.

References GetRxChannelWidth().

Referenced by EndPreambleDetectionPeriod(), EndReceiveField(), EndReceivePayload(), ErasePreambleEvent(), ns3::HePhy::GetMeasurementChannelWidth(), GetPhyHeaderSnrPer(), GetRxPowerWForPpdu(), and StartReceivePreamble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNextField()

WifiPpduField ns3::PhyEntity::GetNextField	(	WifiPpduField	currentField,
		WifiPreamble	preamble
	)		const

Return the field following the provided one.

Parameters

currentField	the considered PPDU field
preamble	the preamble indicating the PPDU format

Returns: the PPDU field following the reference one

Definition at line 148 of file phy-entity.cc.

References GetPpduFormats(), and NS_FATAL_ERROR.

Referenced by EndReceiveField(), and GetPhyHeaderSections().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetNumModes()

uint8_t ns3::PhyEntity::GetNumModes ( void ) const

virtual

Returns: the number of WifiModes supported by this entity

Definition at line 103 of file phy-entity.cc.

References m_modeList.

◆ GetPayloadDuration()

virtual Time ns3::PhyEntity::GetPayloadDuration	(	uint32_t	size,
		const WifiTxVector &	txVector,
		WifiPhyBand	band,
		MpduType	mpdutype,
		bool	incFlag,
		uint32_t &	totalAmpduSize,
		double &	totalAmpduNumSymbols,
		uint16_t	staId
	)		const

pure virtual

Parameters

size	the number of bytes in the packet to send
txVector	the TXVECTOR used for the transmission of this packet
band	the frequency band
mpdutype	the type of the MPDU as defined in WifiPhy::MpduType.
incFlag	this flag is used to indicate that the variables need to be update or not This function is called a couple of times for the same packet so variables should not be increased each time.
totalAmpduSize	the total size of the previously transmitted MPDUs for the concerned A-MPDU. If incFlag is set, this parameter will be updated.
totalAmpduNumSymbols	the number of symbols previously transmitted for the MPDUs in the concerned A-MPDU, used for the computation of the number of symbols needed for the last MPDU. If incFlag is set, this parameter will be updated.
staId	the STA-ID of the PSDU (only used for MU PPDUs)

Returns: the duration of the PSDU

Implemented in ns3::OfdmPhy, ns3::HtPhy, and ns3::DsssPhy.

◆ GetPhyHeaderSections()

PhyEntity::PhyHeaderSections ns3::PhyEntity::GetPhyHeaderSections	(	const WifiTxVector &	txVector,
		Time	ppduStart
	)		const

Return a map of PHY header chunk information per PPDU field.

This map will contain the PPDU fields that are actually present based on the txVector information.

Parameters

txVector	the transmission parameters
ppduStart	the time at which the PPDU started

Returns: the list of preamble sections

See also: PhyHeaderSections

Definition at line 209 of file phy-entity.cc.

References GetDuration(), GetNextField(), ns3::WifiTxVector::GetPreambleType(), GetSigMode(), visualizer.core::start(), ns3::WIFI_PPDU_FIELD_DATA, and ns3::WIFI_PPDU_FIELD_PREAMBLE.

Referenced by PhyHeaderSectionsTest::DoRun(), and GetDurationUpToField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPhyHeaderSnrPer()

PhyEntity::SnrPer ns3::PhyEntity::GetPhyHeaderSnrPer	(	WifiPpduField	field,
		Ptr< Event >	event
	)		const

protected

Obtain the SNR and PER of the PPDU field from the WifiPhy's InterferenceHelper class.

Wrapper used by child classes.

Parameters

field	the PPDU field
event	the event holding incoming PPDU's information

Returns: the SNR and PER

Definition at line 250 of file phy-entity.cc.

References ns3::InterferenceHelper::CalculatePhyHeaderSnrPer(), GetMeasurementChannelWidth(), ns3::WifiPhy::GetPrimaryBand(), ns3::WifiPhy::m_interference, and m_wifiPhy.

Referenced by ns3::DsssPhy::EndReceiveHeader(), ns3::OfdmPhy::EndReceiveHeader(), ns3::HtPhy::EndReceiveHtSig(), ns3::VhtPhy::EndReceiveSigA(), and ns3::VhtPhy::EndReceiveSigB().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetPpduFormats()

virtual const PpduFormats& ns3::PhyEntity::GetPpduFormats ( void ) const

protectedpure virtual

Return the PPDU formats of the PHY.

Returns: the PPDU formats of the PHY

Implemented in ns3::HePhy, ns3::OfdmPhy, ns3::HtPhy, ns3::VhtPhy, and ns3::DsssPhy.

Referenced by DoStartReceiveField(), and GetNextField().

Here is the caller graph for this function:

◆ GetRandomValue()

double ns3::PhyEntity::GetRandomValue ( void ) const

protected

Obtain a random value from the WifiPhy's generator.

Wrapper used by child classes.

Returns: a uniform random value

Definition at line 991 of file phy-entity.cc.

References ns3::UniformRandomVariable::GetValue(), ns3::WifiPhy::m_random, and m_wifiPhy.

Referenced by ns3::DsssPhy::EndReceiveHeader(), ns3::OfdmPhy::EndReceiveHeader(), ns3::HtPhy::EndReceiveHtSig(), ns3::VhtPhy::EndReceiveSigA(), ns3::VhtPhy::EndReceiveSigB(), and GetReceptionStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetReceptionStatus()

std::pair< bool, SignalNoiseDbm > ns3::PhyEntity::GetReceptionStatus	(	Ptr< const WifiPsdu >	psdu,
		Ptr< Event >	event,
		uint16_t	staId,
		Time	relativeMpduStart,
		Time	mpduDuration
	)

protected

Get the reception status for the provided MPDU and notify.

Parameters

psdu	the arriving MPDU formatted as a PSDU
event	the event holding incoming PPDU's information
staId	the station ID of the PSDU (only used for MU)
relativeMpduStart	the relative start time of the MPDU within the A-MPDU. 0 for normal MPDUs
mpduDuration	the duration of the MPDU

Returns: information on MPDU reception: status, signal power (dBm), and noise power (in dBm)

Definition at line 684 of file phy-entity.cc.

References ns3::Time::As(), ns3::InterferenceHelper::CalculatePayloadSnrPer(), ns3::Packet::Copy(), GetChannelWidthAndBand(), ns3::WifiMode::GetDataRate(), ns3::WifiPsdu::GetPacket(), GetRandomValue(), ns3::WifiPsdu::GetSize(), ns3::WifiPhy::m_interference, ns3::WifiPhy::m_postReceptionErrorModel, m_wifiPhy, ns3::Time::NS, NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::RatioToDb(), ns3::SignalNoiseDbm::signal, and ns3::WToDbm().

Referenced by EndOfMpdu().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRemainingDurationAfterField()

Time ns3::PhyEntity::GetRemainingDurationAfterField	(	Ptr< const WifiPpdu >	ppdu,
		WifiPpduField	field
	)		const

Get the remaining duration of the PPDU after the end of the given field.

Parameters

field	the considered PPDU field
ppdu	the received PPDU

Returns: the remaining duration of the PPDU after the end of to the field

Definition at line 325 of file phy-entity.cc.

References GetDuration(), and GetDurationUpToField().

Referenced by EndReceiveField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRxChannelWidth()

uint16_t ns3::PhyEntity::GetRxChannelWidth ( const WifiTxVector & txVector ) const

virtual

Return the channel width used in the reception spectrum model.

Parameters

txVector the TXVECTOR of the PPDU that is being received

Returns: the channel width (in MHz) used for RxSpectrumModel

Reimplemented in ns3::DsssPhy.

Definition at line 1015 of file phy-entity.cc.

References ns3::WifiTxVector::GetChannelWidth(), ns3::WifiPhy::GetChannelWidth(), m_wifiPhy, and min.

Referenced by GetChannelWidthAndBand(), GetMeasurementChannelWidth(), and ns3::DsssPhy::GetRxChannelWidth().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetRxPowerWForPpdu()

double ns3::PhyEntity::GetRxPowerWForPpdu ( Ptr< Event > event ) const

protected

Obtain the received power (W) for a given band.

Wrapper used by child classes.

Parameters

event the event holding incoming PPDU's information

Returns: the received power (W) for the event over a given band

Definition at line 997 of file phy-entity.cc.

References GetMeasurementChannelWidth(), ns3::WifiPhy::GetPrimaryBand(), and m_wifiPhy.

Referenced by ns3::HePhy::ProcessSigA(), and StartPreambleDetectionPeriod().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetSigMode()

WifiMode ns3::PhyEntity::GetSigMode	(	WifiPpduField	field,
		const WifiTxVector &	txVector
	)		const

virtual

Get the WifiMode for the SIG field specified by the PPDU field.

Parameters

field	the PPDU field
txVector	the transmission parameters

Returns: the WifiMode used for the SIG field

Reimplemented in ns3::HePhy, ns3::OfdmPhy, ns3::HtPhy, ns3::VhtPhy, and ns3::DsssPhy.

Definition at line 141 of file phy-entity.cc.

References NS_FATAL_ERROR.

Referenced by GetPhyHeaderSections(), ns3::DsssPhy::GetSigMode(), ns3::HtPhy::GetSigMode(), and ns3::OfdmPhy::GetSigMode().

Here is the caller graph for this function:

◆ GetStaId()

uint16_t ns3::PhyEntity::GetStaId ( const Ptr< const WifiPpdu > ppdu ) const

virtual

Return the STA ID that has been assigned to the station this PHY belongs to.

This is typically called for MU PPDUs, in order to pick the correct PSDU.

Parameters

ppdu	the PPDU for which the STA ID is requested

Returns: the STA ID

Reimplemented in ns3::HePhy, and OfdmaTestHePhy.

Definition at line 519 of file phy-entity.cc.

References SU_STA_ID.

Referenced by DoStartReceivePayload(), EndOfMpdu(), EndReceivePayload(), ns3::HePhy::GetStaId(), and ScheduleEndOfMpdus().

Here is the caller graph for this function:

◆ GetTxMaskRejectionParams()

std::tuple< double, double, double > ns3::PhyEntity::GetTxMaskRejectionParams ( void ) const

protected

Returns: a tuple containing the minimum rejection (in dBr) for the inner band, the minimum rejection (in dBr) for the outer band, and the maximum rejection (in dBr) for the outer band for the transmit spectrum mask.

Wrapper method used by child classes for PSD generation.

Definition at line 1067 of file phy-entity.cc.

References ns3::WifiPhy::GetTxMaskRejectionParams(), and m_wifiPhy.

Referenced by ns3::OfdmPhy::GetTxPowerSpectralDensity(), ns3::HePhy::GetTxPowerSpectralDensity(), and ns3::HtPhy::GetTxPowerSpectralDensity().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetTxPowerSpectralDensity()

virtual Ptr<SpectrumValue> ns3::PhyEntity::GetTxPowerSpectralDensity	(	double	txPowerW,
		Ptr< const WifiPpdu >	ppdu
	)		const

protectedpure virtual

Parameters

txPowerW	power in W to spread across the bands
ppdu	the PPDU that will be transmitted

Returns: Pointer to SpectrumValue

This is a helper function to create the right TX PSD corresponding to the amendment of this PHY.

Implemented in ns3::HtPhy, ns3::HePhy, ns3::OfdmPhy, and ns3::DsssPhy.

Referenced by Transmit().

Here is the caller graph for this function:

◆ GetWifiConstPsduMap()

WifiConstPsduMap ns3::PhyEntity::GetWifiConstPsduMap	(	Ptr< const WifiPsdu >	psdu,
		const WifiTxVector &	txVector
	)		const

virtual

Get a WifiConstPsduMap from a PSDU and the TXVECTOR to use to send the PSDU.

The STA-ID value is properly determined based on whether the given PSDU has to be transmitted as a DL or UL frame.

Parameters

psdu	the given PSDU
txVector	the TXVECTOR to use to send the PSDU

Returns: a WifiConstPsduMap built from the given PSDU and the given TXVECTOR

Reimplemented in ns3::HePhy.

Definition at line 197 of file phy-entity.cc.

References SU_STA_ID.

◆ HandlesMcsModes()

bool ns3::PhyEntity::HandlesMcsModes ( void ) const

virtual

Check if the WifiModes handled by this PHY are MCSs.

Returns: true if the handled WifiModes are MCSs, false if they are non-MCS modes

Reimplemented in ns3::HtPhy.

Definition at line 123 of file phy-entity.cc.

◆ IsConfigSupported()

bool ns3::PhyEntity::IsConfigSupported ( Ptr< const WifiPpdu > ppdu ) const

protectedvirtual

Checks if the signaled configuration (excluding bandwidth) is supported by the PHY.

Parameters

ppdu	the received PPDU

Returns: true if supported, false otherwise

Reimplemented in ns3::HtPhy, and ns3::HePhy.

Definition at line 901 of file phy-entity.cc.

References IsModeSupported(), and NS_LOG_DEBUG.

Referenced by ns3::DsssPhy::EndReceiveHeader(), and ns3::OfdmPhy::IsAllConfigSupported().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ IsMcsSupported()

bool ns3::PhyEntity::IsMcsSupported ( uint8_t index ) const

virtual

Check if the WifiMode corresponding to the given MCS index is supported.

Parameters

index the index of the MCS

Returns: true if the WifiMode corresponding to the MCS index is supported, false otherwise

Will return false for non-MCS modes.

Reimplemented in ns3::HtPhy.

Definition at line 116 of file phy-entity.cc.

References NS_ABORT_MSG.

◆ IsModeSupported()

bool ns3::PhyEntity::IsModeSupported ( WifiMode mode ) const

virtual

Check if the WifiMode is supported.

Parameters

mode	the WifiMode to check

Returns: true if the WifiMode is supported, false otherwise

Definition at line 90 of file phy-entity.cc.

References m_modeList.

Referenced by ns3::HePhy::IsConfigSupported(), ns3::HtPhy::IsConfigSupported(), and IsConfigSupported().

Here is the caller graph for this function:

◆ NoEndPreambleDetectionEvents()

bool ns3::PhyEntity::NoEndPreambleDetectionEvents ( void ) const

Returns: true if there is no end preamble detection event running, false otherwise

Definition at line 929 of file phy-entity.cc.

References m_endPreambleDetectionEvents.

◆ NotifyInterferenceRxEndAndClear()

void ns3::PhyEntity::NotifyInterferenceRxEndAndClear ( bool reset )

protected

Notify WifiPhy's InterferenceHelper of the end of the reception, clear maps and end of MPDU event, and eventually reset WifiPhy.

Parameters

reset whether to reset WifiPhy

Definition at line 763 of file phy-entity.cc.

References m_endOfMpduEvents, ns3::WifiPhy::m_interference, m_signalNoiseMap, m_statusPerMpduMap, m_wifiPhy, ns3::InterferenceHelper::NotifyRxEnd(), ns3::Simulator::Now(), NS_ASSERT, and ns3::WifiPhy::Reset().

Referenced by ns3::HePhy::DoEndReceivePayload(), and DoEndReceivePayload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ObtainNextUid()

uint64_t ns3::PhyEntity::ObtainNextUid ( const WifiTxVector & txVector )

protectedvirtual

Obtain the next UID for the PPDU to transmit.

Note that the global UID counter could be incremented.

Parameters

txVector the transmission parameters

Returns: the UID to use for the PPDU to transmit

Reimplemented in ns3::HePhy.

Definition at line 1021 of file phy-entity.cc.

References m_globalPpduUid, and NS_LOG_FUNCTION.

Referenced by ns3::ErpOfdmPhy::BuildPpdu(), ns3::DsssPhy::BuildPpdu(), ns3::VhtPhy::BuildPpdu(), ns3::HtPhy::BuildPpdu(), and ns3::OfdmPhy::BuildPpdu().

Here is the caller graph for this function:

◆ ResetReceive()

void ns3::PhyEntity::ResetReceive ( Ptr< Event > event )

Reset PHY at the end of the PPDU under reception after it has failed the PHY header.

Parameters

event the event holding incoming PPDU's information

Definition at line 974 of file phy-entity.cc.

References DoResetReceive(), m_endRxPayloadEvents, m_wifiPhy, NS_ASSERT, NS_LOG_FUNCTION, and ns3::WifiPhy::ResetReceive().

Referenced by ns3::HePhy::DoStartReceivePayload(), and EndReceiveField().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ScheduleEndOfMpdus()

void ns3::PhyEntity::ScheduleEndOfMpdus ( Ptr< Event > event )

protected

Schedule end of MPDUs events.

Parameters

event the event holding incoming PPDU's information

Definition at line 554 of file phy-entity.cc.

References ns3::Time::As(), ns3::WifiPsdu::begin(), CalculatePhyPreambleAndHeaderDuration(), ns3::WifiPsdu::end(), EndOfMpdu(), ns3::FIRST_MPDU_IN_AGGREGATE, GetAddressedPsduInPpdu(), ns3::WifiPsdu::GetAmpduSubframeSize(), ns3::WifiTxVector::GetGuardInterval(), ns3::WifiPsdu::GetNMpdus(), ns3::WifiPhy::GetPayloadDuration(), ns3::WifiPhy::GetPhyBand(), ns3::WifiPsdu::GetSize(), GetStaId(), ns3::WifiPsdu::IsSingle(), ns3::Time::IsZero(), ns3::LAST_MPDU_IN_AGGREGATE, m_endOfMpduEvents, m_wifiPhy, ns3::MIDDLE_MPDU_IN_AGGREGATE, ns3::NanoSeconds(), ns3::NORMAL_MPDU, ns3::Time::NS, NS_LOG_FUNCTION, NS_LOG_INFO, ns3::Simulator::Schedule(), and ns3::SINGLE_MPDU.

Referenced by DoStartReceivePayload(), and ns3::HePhy::StartReceiveOfdmaPayload().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetOwner()

void ns3::PhyEntity::SetOwner ( Ptr< WifiPhy > wifiPhy )

Set the WifiPhy owning this PHY entity.

Parameters

wifiPhy the WifiPhy owning this PHY entity

Definition at line 82 of file phy-entity.cc.

References m_state, ns3::WifiPhy::m_state, m_wifiPhy, and NS_LOG_FUNCTION.

Referenced by OfdmaSpectrumWifiPhy::OfdmaSpectrumWifiPhy().

Here is the caller graph for this function:

◆ StartPreambleDetectionPeriod()

void ns3::PhyEntity::StartPreambleDetectionPeriod ( Ptr< Event > event )

protected

Start the preamble detection period.

Parameters

event the event holding incoming PPDU's information

Definition at line 788 of file phy-entity.cc.

References EndPreambleDetectionPeriod(), ns3::WifiPhy::GetPreambleDetectionDuration(), GetRxPowerWForPpdu(), m_endPreambleDetectionEvents, ns3::WifiPhy::m_interference, m_wifiPhy, ns3::InterferenceHelper::NotifyRxStart(), NS_LOG_DEBUG, NS_LOG_FUNCTION, ns3::Simulator::Schedule(), and ns3::WToDbm().

Referenced by StartReceivePreamble().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ StartReceiveField()

void ns3::PhyEntity::StartReceiveField	(	WifiPpduField	field,
		Ptr< Event >	event
	)

Start receiving a given field.

This method will call the DoStartReceiveField. EndReceiveField is also scheduled after the duration of the field (except for the special case of preambles