A Discrete-Event Network Simulator
API
Loading...
Searching...
No Matches
ns3::lorawan::LoraInterferenceHelper::Event Class Reference

A class representing a signal in time. More...

#include "lora-interference-helper.h"

+ Inheritance diagram for ns3::lorawan::LoraInterferenceHelper::Event:
+ Collaboration diagram for ns3::lorawan::LoraInterferenceHelper::Event:

Public Member Functions

 Event (Time duration, double rxPowerdBm, uint8_t spreadingFactor, Ptr< Packet > packet, uint32_t frequencyHz)
 Construct a new interference signal Event object.
 
 ~Event ()
 Destructor.
 
Time GetDuration () const
 Get the duration of the event.
 
Time GetEndTime () const
 Get the ending time of the event.
 
uint32_t GetFrequency () const
 Get the frequency this event was on.
 
Ptr< PacketGetPacket () const
 Get the packet this event was generated for.
 
double GetRxPowerdBm () const
 Get the power of the event.
 
uint8_t GetSpreadingFactor () const
 Get the spreading factor used by this signal.
 
Time GetStartTime () const
 Get the starting time of the event.
 
void Print (std::ostream &stream) const
 Print the current event in a human readable form.
 
- Public Member Functions inherited from ns3::SimpleRefCount< LoraInterferenceHelper::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
 The time this signal ends (at the device).
 
uint32_t m_frequencyHz
 The carrier frequency [Hz] this event was on.
 
Ptr< Packetm_packet
 The packet this event was generated for.
 
double m_rxPowerdBm
 The power of this event in dBm (at the device).
 
uint8_t m_sf
 The spreading factor of this signal.
 
Time m_startTime
 The time this signal begins (at the device).
 

Detailed Description

A class representing a signal in time.

Used in LoraInterferenceHelper to keep track of which signals overlap and cause destructive interference.

Definition at line 46 of file lora-interference-helper.h.

Constructor & Destructor Documentation

◆ Event()

ns3::lorawan::LoraInterferenceHelper::Event::Event ( Time duration,
double rxPowerdBm,
uint8_t spreadingFactor,
Ptr< Packet > packet,
uint32_t frequencyHz )

Construct a new interference signal Event object.

Parameters
durationThe duration in time.
rxPowerdBmThe power of the signal.
spreadingFactorThe modulation spreading factor.
packetThe packet transmitted.
frequencyHzThe carrier frequency [Hz] of the signal.

Definition at line 28 of file lora-interference-helper.cc.

References m_endTime, m_frequencyHz, m_packet, m_rxPowerdBm, m_sf, m_startTime, and ns3::Now().

+ Here is the call graph for this function:

◆ ~Event()

ns3::lorawan::LoraInterferenceHelper::Event::~Event ( )

Destructor.

Definition at line 44 of file lora-interference-helper.cc.

Member Function Documentation

◆ GetDuration()

Time ns3::lorawan::LoraInterferenceHelper::Event::GetDuration ( ) const

Get the duration of the event.

Returns
The duration in time.

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

References m_endTime, and m_startTime.

◆ GetEndTime()

Time ns3::lorawan::LoraInterferenceHelper::Event::GetEndTime ( ) const

Get the ending time of the event.

Returns
The end time.

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

References m_endTime.

◆ GetFrequency()

uint32_t ns3::lorawan::LoraInterferenceHelper::Event::GetFrequency ( ) const

Get the frequency this event was on.

Returns
The carrier frequency [Hz] as a uint32_t.

Definition at line 87 of file lora-interference-helper.cc.

References m_frequencyHz.

◆ GetPacket()

Ptr< Packet > ns3::lorawan::LoraInterferenceHelper::Event::GetPacket ( ) const

Get the packet this event was generated for.

Returns
A pointer to the packet.

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

References m_packet.

◆ GetRxPowerdBm()

double ns3::lorawan::LoraInterferenceHelper::Event::GetRxPowerdBm ( ) const

Get the power of the event.

Returns
The power in dBm as a double.

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

References m_rxPowerdBm.

◆ GetSpreadingFactor()

uint8_t ns3::lorawan::LoraInterferenceHelper::Event::GetSpreadingFactor ( ) const

Get the spreading factor used by this signal.

Returns
The spreading factor value.

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

References m_sf.

◆ GetStartTime()

Time ns3::lorawan::LoraInterferenceHelper::Event::GetStartTime ( ) const

Get the starting time of the event.

Returns
The starting time.

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

References m_startTime.

◆ Print()

void ns3::lorawan::LoraInterferenceHelper::Event::Print ( std::ostream & stream) const

Print the current event in a human readable form.

Parameters
streamThe output stream to use.

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

References m_endTime, m_frequencyHz, m_rxPowerdBm, m_sf, m_startTime, and ns3::Time::S.

Member Data Documentation

◆ m_endTime

Time ns3::lorawan::LoraInterferenceHelper::Event::m_endTime
private

The time this signal ends (at the device).

Definition at line 124 of file lora-interference-helper.h.

Referenced by Event(), GetDuration(), GetEndTime(), and Print().

◆ m_frequencyHz

uint32_t ns3::lorawan::LoraInterferenceHelper::Event::m_frequencyHz
private

The carrier frequency [Hz] this event was on.

Definition at line 128 of file lora-interference-helper.h.

Referenced by Event(), GetFrequency(), and Print().

◆ m_packet

Ptr<Packet> ns3::lorawan::LoraInterferenceHelper::Event::m_packet
private

The packet this event was generated for.

Definition at line 127 of file lora-interference-helper.h.

Referenced by Event(), and GetPacket().

◆ m_rxPowerdBm

double ns3::lorawan::LoraInterferenceHelper::Event::m_rxPowerdBm
private

The power of this event in dBm (at the device).

Definition at line 126 of file lora-interference-helper.h.

Referenced by Event(), GetRxPowerdBm(), and Print().

◆ m_sf

uint8_t ns3::lorawan::LoraInterferenceHelper::Event::m_sf
private

The spreading factor of this signal.

Definition at line 125 of file lora-interference-helper.h.

Referenced by Event(), GetSpreadingFactor(), and Print().

◆ m_startTime

Time ns3::lorawan::LoraInterferenceHelper::Event::m_startTime
private

The time this signal begins (at the device).

Definition at line 123 of file lora-interference-helper.h.

Referenced by Event(), GetDuration(), GetStartTime(), and Print().


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