A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
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.
 
Time GetDuration () const
 Return the duration of the signal.
 
Time GetEndTime () const
 Return the end time of the signal.
 
Ptr< const WifiPpduGetPpdu () const
 Return the PPDU.
 
Watt_u GetRxPower () const
 Return the total received power.
 
Watt_u GetRxPower (const WifiSpectrumBandInfo &band) const
 Return the received power for a given band.
 
const RxPowerWattPerChannelBandGetRxPowerPerBand () const
 Return the received power (W) for all bands.
 
Time GetStartTime () const
 Return the start time of the signal.
 
void UpdatePpdu (Ptr< const WifiPpdu > ppdu)
 Update the PPDU that initially generated the event.
 
void UpdateRxPowerW (const RxPowerWattPerChannelBand &rxPower)
 Update the received power (W) for all bands, i.e.
 
- Public Member Functions inherited from ns3::SimpleRefCount< Event >
 SimpleRefCount ()
 Default constructor.
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor.
 
uint32_t GetReferenceCount () const
 Get the reference count of the object.
 
SimpleRefCountoperator= (const SimpleRefCount &o)
 Assignment operator.
 
void Ref () const
 Increment the reference count.
 
void Unref () const
 Decrement the reference count.
 

Private Attributes

Time m_endTime
 end time
 
Ptr< const WifiPpdum_ppdu
 PPDU.
 
RxPowerWattPerChannelBand m_rxPowerW
 received power in watts per band
 
Time m_startTime
 start time
 

Detailed Description

handles interference calculations

signal event for a PPDU.

Definition at line 28 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
ppduthe PPDU
durationduration of the PPDU
rxPowerthe received power per band (W)

Definition at line 37 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 64 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 58 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 46 of file interference-helper.cc.

References m_ppdu.

◆ GetRxPower() [1/2]

Watt_u ns3::Event::GetRxPower ( ) const

Return the total received power.

Returns
the total received power

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

References m_rxPowerW, and NS_ASSERT.

◆ GetRxPower() [2/2]

Watt_u ns3::Event::GetRxPower ( const WifiSpectrumBandInfo & band) const

Return the received power for a given band.

Parameters
bandthe band for which the power should be returned
Returns
the received power for a given band

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

References m_rxPowerW, and NS_ASSERT.

◆ GetRxPowerPerBand()

const RxPowerWattPerChannelBand & ns3::Event::GetRxPowerPerBand ( ) const

Return the received power (W) for all bands.

Returns
the received power (W) for all bands.

Definition at line 90 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 52 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
ppduthe new PPDU to use for this event.

Definition at line 112 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
rxPowerthe received power (W) for all bands.

Definition at line 96 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 104 of file interference-helper.h.

Referenced by GetDuration(), and GetEndTime().

◆ m_ppdu

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

PPDU.

Definition at line 102 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 105 of file interference-helper.h.

Referenced by GetRxPower(), GetRxPower(), GetRxPowerPerBand(), and UpdateRxPowerW().

◆ m_startTime

Time ns3::Event::m_startTime
private

start time

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

Referenced by GetDuration(), and GetStartTime().


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