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, const WifiTxVector &txVector, Time duration, RxPowerWattPerChannelBand &&rxPower)
	Create an Event with the given parameters. More...
	~Event ()
Time	GetDuration (void) const
	Return the duration of the signal. More...
Time	GetEndTime (void) const
	Return the end time of the signal. More...
Ptr< const WifiPpdu >	GetPpdu (void) const
	Return the PPDU. More...
double	GetRxPowerW (void) const
	Return the total received power (W). More...
double	GetRxPowerW (WifiSpectrumBand band) const
	Return the received power (W) for a given band. More...
const RxPowerWattPerChannelBand &	GetRxPowerWPerBand (void) const
	Return the received power (W) for all bands. More...
Time	GetStartTime (void) const
	Return the start time of the signal. More...
const WifiTxVector &	GetTxVector (void) const
	Return the TXVECTOR of the PPDU. 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 (void) const
	Get the reference count of the object. More...
SimpleRefCount &	operator= ([[maybe_unused]] const SimpleRefCount &o)
	Assignment operator. More...
void	Ref (void) const
	Increment the reference count. More...
void	Unref (void) 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...
WifiTxVector	m_txVector
	TXVECTOR. More...

Detailed Description

handles interference calculations

signal event for a PPDU.

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

Constructor & Destructor Documentation

Event()

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

Create an Event with the given parameters.

Note that rxPower will be moved into this object.

Parameters

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

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

~Event()

ns3::Event::~Event

(

)

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

References m_ppdu, and m_rxPowerW.

Member Function Documentation

GetDuration()

Time ns3::Event::GetDuration

(

void

)

const

Return the duration of the signal.

Returns

the duration of the signal

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

References m_endTime, and m_startTime.

GetEndTime()

Time ns3::Event::GetEndTime

(

void

)

const

Return the end time of the signal.

Returns

the end time of the signal

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

References m_endTime.

GetPpdu()

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

(

void

)

const

Return the PPDU.

Returns

the PPDU

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

References m_ppdu.

GetRxPowerW() [1/2]

double ns3::Event::GetRxPowerW

(

void

)

const

Return the total received power (W).

Returns

the total received power (W)

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

References m_rxPowerW, and NS_ASSERT.

GetRxPowerW() [2/2]

double ns3::Event::GetRxPowerW

(

WifiSpectrumBand

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 95 of file interference-helper.cc.

References m_rxPowerW, and NS_ASSERT.

GetRxPowerWPerBand()

const RxPowerWattPerChannelBand & ns3::Event::GetRxPowerWPerBand

(

void

)

const

Return the received power (W) for all bands.

Returns

the received power (W) for all bands.

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

References m_rxPowerW.

GetStartTime()

Time ns3::Event::GetStartTime

(

void

)

const

Return the start time of the signal.

Returns

the start time of the signal

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

References m_startTime.

GetTxVector()

const WifiTxVector & ns3::Event::GetTxVector

(

void

)

const

Return the TXVECTOR of the PPDU.

Returns

the TXVECTOR of the PPDU

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

References m_txVector.

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 115 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 114 of file interference-helper.h.

Referenced by GetDuration(), and GetEndTime().

m_ppdu

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

private

PPDU.

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

Referenced by ~Event(), and GetPpdu().

m_rxPowerW

RxPowerWattPerChannelBand ns3::Event::m_rxPowerW

private

received power in watts per band

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

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

m_startTime

Time ns3::Event::m_startTime

private

start time

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

Referenced by GetDuration(), and GetStartTime().

m_txVector

WifiTxVector ns3::Event::m_txVector

private

TXVECTOR.

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

Referenced by GetTxVector().

---

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

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