A Discrete-Event Network Simulator
API
Public Member Functions | Private Attributes | List of all members
ns3::Event Class Reference

handles interference calculations More...

#include "interference-helper.h"

+ Inheritance diagram for ns3::Event:

Public Member Functions

 Event (Ptr< const Packet > packet, WifiTxVector txVector, Time duration, double rxPower)
 Create an Event with the given parameters. More...
 
 ~Event ()
 
Time GetEndTime (void) const
 Return the end time of the signal. More...
 
Ptr< const PacketGetPacket (void) const
 Return the packet. More...
 
WifiMode GetPayloadMode (void) const
 Return the Wi-Fi mode used for the payload. More...
 
double GetRxPowerW (void) const
 Return the receive power (w). More...
 
Time GetStartTime (void) const
 Return the start time of the signal. More...
 
WifiTxVector GetTxVector (void) const
 Return the TXVECTOR of the packet. 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 Packetm_packet
 packet More...
 
double m_rxPowerW
 receive power in watts More...
 
Time m_startTime
 start time More...
 
WifiTxVector m_txVector
 TXVECTOR. More...
 

Detailed Description

handles interference calculations

signal event for a packet.

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

Constructor & Destructor Documentation

◆ Event()

ns3::Event::Event ( Ptr< const Packet packet,
WifiTxVector  txVector,
Time  duration,
double  rxPower 
)

Create an Event with the given parameters.

Parameters
packetthe packet
txVectorTXVECTOR of the packet
durationduration of the signal
rxPowerthe receive power (w)

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

◆ ~Event()

ns3::Event::~Event ( )

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

Member Function Documentation

◆ GetEndTime()

Time ns3::Event::GetEndTime ( void  ) const

Return the end time of the signal.

Returns
the end time of the signal

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

References m_endTime.

◆ GetPacket()

Ptr< const Packet > ns3::Event::GetPacket ( void  ) const

Return the packet.

Returns
the packet

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

References m_packet.

◆ GetPayloadMode()

WifiMode ns3::Event::GetPayloadMode ( void  ) const

Return the Wi-Fi mode used for the payload.

Returns
the Wi-Fi mode used for the payload

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

References ns3::WifiTxVector::GetMode(), and m_txVector.

◆ GetRxPowerW()

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

Return the receive power (w).

Returns
the receive power (w)

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

References m_startTime.

◆ GetTxVector()

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

Return the TXVECTOR of the packet.

Returns
the TXVECTOR of the packet

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

References m_txVector.

Member Data Documentation

◆ m_endTime

Time ns3::Event::m_endTime
private

end time

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

Referenced by GetEndTime().

◆ m_packet

Ptr<const Packet> ns3::Event::m_packet
private

packet

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

Referenced by GetPacket().

◆ m_rxPowerW

double ns3::Event::m_rxPowerW
private

receive power in watts

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

Referenced by GetRxPowerW().

◆ m_startTime

Time ns3::Event::m_startTime
private

start time

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

Referenced by GetStartTime().

◆ m_txVector

WifiTxVector ns3::Event::m_txVector
private

TXVECTOR.

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

Referenced by GetPayloadMode(), and GetTxVector().


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