ns3::Event Class Reference

handles interference calculations More...

#include "interference-helper.h"

Inheritance diagram for ns3::Event:

Collaboration diagram for ns3::Event:

Public Member Functions
	Event (Ptr< const WifiPpdu > ppdu, Time duration, RxPowerWattPerChannelBand &&rxPower)
	Create an Event with the given parameters. More...
Time	GetDuration () const
	Return the duration of the signal. More...
Time	GetEndTime () const
	Return the end time of the signal. More...
Ptr< const WifiPpdu >	GetPpdu () const
	Return the PPDU. More...
double	GetRxPowerW () const
	Return the total received power (W). More...
double	GetRxPowerW (const WifiSpectrumBandInfo &band) const
	Return the received power (W) for a given band. More...
const RxPowerWattPerChannelBand &	GetRxPowerWPerBand () const
	Return the received power (W) for all bands. More...
Time	GetStartTime () const
	Return the start time of the signal. More...
void	UpdatePpdu (Ptr< const WifiPpdu > ppdu)
	Update the PPDU that initially generated the event. More...
void	UpdateRxPowerW (const RxPowerWattPerChannelBand &rxPower)
	Update the received power (W) for all bands, i.e. More...
Public Member Functions inherited from ns3::SimpleRefCount< Event >
	SimpleRefCount ()
	Default constructor. More...
	SimpleRefCount (const SimpleRefCount &o[[maybe_unused]])
	Copy constructor. More...
uint32_t	GetReferenceCount () const
	Get the reference count of the object. More...
SimpleRefCount &	operator= (const SimpleRefCount &o[[maybe_unused]])
	Assignment operator. More...
void	Ref () const
	Increment the reference count. More...
void	Unref () const
	Decrement the reference count. More...

Private Attributes
Time	m_endTime
	end time More...
Ptr< const WifiPpdu >	m_ppdu
	PPDU. More...
RxPowerWattPerChannelBand	m_rxPowerW
	received power in watts per band More...
Time	m_startTime
	start time More...

Detailed Description

handles interference calculations

signal event for a PPDU.

Definition at line 39 of file interference-helper.h.

Constructor & Destructor Documentation

Event()

ns3::Event::Event	(	Ptr< const WifiPpdu >	ppdu,
		Time	duration,
		RxPowerWattPerChannelBand &&	rxPower
	)

Create an Event with the given parameters.

Note that rxPower will be moved into this object.

Parameters

ppdu	the PPDU
duration	duration of the PPDU
rxPower	the received power per band (W)

Definition at line 48 of file interference-helper.cc.

Member Function Documentation

GetDuration()

Time ns3::Event::GetDuration

(

)

const

Return the duration of the signal.

Returns

the duration of the signal

Definition at line 75 of file interference-helper.cc.

References m_endTime, and m_startTime.

GetEndTime()

Time ns3::Event::GetEndTime

(

)

const

Return the end time of the signal.

Returns

the end time of the signal

Definition at line 69 of file interference-helper.cc.

References m_endTime.

GetPpdu()

Ptr< const WifiPpdu > ns3::Event::GetPpdu

(

)

const

Return the PPDU.

Returns

the PPDU

Definition at line 57 of file interference-helper.cc.

References m_ppdu.

GetRxPowerW() [1/2]

double ns3::Event::GetRxPowerW

(

)

const

Return the total received power (W).

Returns

the total received power (W)

Definition at line 81 of file interference-helper.cc.

References m_rxPowerW, and NS_ASSERT.

GetRxPowerW() [2/2]

double ns3::Event::GetRxPowerW

(

const WifiSpectrumBandInfo &

band

)

const

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

Parameters

band	the band for which the power should be returned

Returns

the received power (W) for a given band

Definition at line 93 of file interference-helper.cc.

References m_rxPowerW, and NS_ASSERT.

GetRxPowerWPerBand()

const RxPowerWattPerChannelBand & ns3::Event::GetRxPowerWPerBand

(

)

const

Return the received power (W) for all bands.

Returns

the received power (W) for all bands.

Definition at line 101 of file interference-helper.cc.

References m_rxPowerW.

GetStartTime()

Time ns3::Event::GetStartTime

(

)

const

Return the start time of the signal.

Returns

the start time of the signal

Definition at line 63 of file interference-helper.cc.

References m_startTime.

UpdatePpdu()

void ns3::Event::UpdatePpdu

(

Ptr< const WifiPpdu >

ppdu

)

Update the PPDU that initially generated the event.

This is needed to have the PPDU holding the correct TXVECTOR upon reception of multiple signals carring the same content but over different channel width (typically non-HT duplicates).

Parameters

ppdu	the new PPDU to use for this event.

Definition at line 123 of file interference-helper.cc.

References m_ppdu.

UpdateRxPowerW()

void ns3::Event::UpdateRxPowerW

(

const RxPowerWattPerChannelBand &

rxPower

)

Update the received power (W) for all bands, i.e.

add up the received power to the current received power, for each band.

Parameters

rxPower

the received power (W) for all bands.

Definition at line 107 of file interference-helper.cc.

References m_rxPowerW, and NS_ASSERT.

Member Data Documentation

m_endTime

Time ns3::Event::m_endTime

private

end time

Definition at line 115 of file interference-helper.h.

Referenced by GetDuration(), and GetEndTime().

m_ppdu

Ptr<const WifiPpdu> ns3::Event::m_ppdu

private

PPDU.

Definition at line 113 of file interference-helper.h.

Referenced by GetPpdu(), and UpdatePpdu().

m_rxPowerW

RxPowerWattPerChannelBand ns3::Event::m_rxPowerW

private

received power in watts per band

Definition at line 116 of file interference-helper.h.

Referenced by GetRxPowerW(), GetRxPowerWPerBand(), and UpdateRxPowerW().

m_startTime

Time ns3::Event::m_startTime

private

start time

Definition at line 114 of file interference-helper.h.

Referenced by GetDuration(), and GetStartTime().

---

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

• src/wifi/model/interference-helper.h
• src/wifi/model/interference-helper.cc