A Discrete-Event Network Simulator
API
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, WifiTxVector txVector, Time duration, double 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 WifiPpduGetPpdu (void) const
 Return the PPDU. More...
 
Ptr< const WifiPsduGetPsdu (void) const
 Return the PSDU in the PPDU. More...
 
double GetRxPowerW (void) const
 Return the received power (w). More...
 
Time GetStartTime (void) const
 Return the start time of the signal. More...
 
WifiTxVector GetTxVector (void) const
 Return the TXVECTOR of the PPDU. More...
 
- Public Member Functions inherited from ns3::SimpleRefCount< Event >
 SimpleRefCount ()
 Default constructor. More...
 
 SimpleRefCount (const SimpleRefCount &o)
 Copy constructor. More...
 
uint32_t GetReferenceCount (void) const
 Get the reference count of the object. More...
 
SimpleRefCountoperator= (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 WifiPpdum_ppdu
 PPDU. More...
 
double m_rxPowerW
 received power in watts 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 39 of file interference-helper.h.

Constructor & Destructor Documentation

◆ Event()

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

Create an Event with the given parameters.

Parameters
ppduthe PPDU
txVectorthe TXVECTOR
durationduration of the PPDU
rxPowerthe received power (w)

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

◆ ~Event()

ns3::Event::~Event ( )

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

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 78 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 72 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 60 of file interference-helper.cc.

References m_ppdu.

◆ GetPsdu()

Ptr< const WifiPsdu > ns3::Event::GetPsdu ( void  ) const

Return the PSDU in the PPDU.

Returns
the PSDU in the PPDU

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

References m_ppdu.

◆ GetRxPowerW()

double ns3::Event::GetRxPowerW ( void  ) const

Return the received power (w).

Returns
the received power (w)

Definition at line 84 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 66 of file interference-helper.cc.

References m_startTime.

◆ GetTxVector()

WifiTxVector ns3::Event::GetTxVector ( void  ) const

Return the TXVECTOR of the PPDU.

Returns
the TXVECTOR of the PPDU

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

References m_txVector.

Member Data Documentation

◆ m_endTime

Time ns3::Event::m_endTime
private

end time

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

Referenced by GetDuration(), and GetEndTime().

◆ m_ppdu

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

PPDU.

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

Referenced by GetPpdu(), and GetPsdu().

◆ m_rxPowerW

double ns3::Event::m_rxPowerW
private

received power in watts

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

Referenced by GetRxPowerW().

◆ m_startTime

Time ns3::Event::m_startTime
private

start time

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

Referenced by GetDuration(), and GetStartTime().

◆ m_txVector

WifiTxVector ns3::Event::m_txVector
private

TXVECTOR.

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

Referenced by GetTxVector().


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